Skip to navigation
Sigma REST APIWebhooks

Retrieve webhook message schema (Beta)

View as Markdown

Retrieve the schema for an action sequence in a workbook configured to be triggered from a webhook.

Beta: This documentation describes a public beta feature and is subject to the Beta features disclaimer.

To send data to this webhook, see the /v2/webhooks/{workbookId}/{sequenceId} endpoint.

Usage notes

  • Retrieve the workbookId by calling the /v2/workbooks endpoint.
  • Retrieve the webhook URL, which contains the workbookId and sequenceId, by creating a webhook through the Sigma UI. The URL will be formatted as /v2/webhooks/{workbookId}/{sequenceId}.
  • The keys included in the response variables are the same JSON keys used in the POST body for /v2/webhooks/{workbookId}/{sequenceId}.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

workbookIdstringRequired
The unique identifier of the workbook.
sequenceIdstringRequired
The unique identifier of the sequence.

Response

The response body.
variablesmap from strings to objects

Key-value pairs of the fields to send to a webhook.