---
title: "Canvas user interacted"
method: POST
path: "canvas_userInteracted"
---

# Canvas user interacted

`POST canvas_userInteracted` (webhook)

Sent when a user interacts with an app canvas via button press. Event type: `v2.canvas.userInteracted`.

## Payload

- CanvasInteractionWebhookV2Envelope
  - `app` CanvasInteractionWebhookV2EnvelopeApp, required
    - `id` string, required: Destination app's id
  - `appDefinition` CanvasInteractionWebhookV2EnvelopeAppDefinition, required
    - `id` string, required: App definition id
    - `versionNumber` string, required: App definition version number
  - `baseURL` string, required: Base tenant URL from which the webhook is coming
  - `channel` 'events' | 'app_signals', required: Channel of the webhook
  - `tenantId` string, required: Global tenant id from which the webhook is coming
  - `version` '0', required: Version of the webhook envelope shape. Always 0.
  - `message` CanvasInteractionWebhookV2, required: Sent when a user interacts with an app canvas via button press
    - `buttonId` string, required
    - `canvasId` string, required
    - `deprecated` boolean, required
    - `featureId` string, required
    - `userId` string, required

## Acknowledgement `200`

Webhook received successfully

---

[API](https://skmtc.dev/benchling/apis/benchling-webhooks-v2.md) - [All operations](https://skmtc.dev/benchling/apis/benchling-webhooks-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/benchling/apis/benchling-webhooks-v2/revisions/4e78eb99a29d?raw)