Skip to navigation
Sigma REST APIWebhooks

Send to a webhook (Beta)

View as Markdown

Post data to a webhook endpoint. The request body must match the webhook specification configured in Sigma.

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

To retrieve the expected request body fields before sending data, see the /v2/webhooks/{workbookId}/{sequenceId}/schema 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}.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

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

Request

A JSON object that matches the webhook specification configured in Sigma.

Response

The accepted webhook action, including its trace ID when available.
traceIdstringOptional
The action trace ID.