SIsigmacomputing

Send to a webhook (Beta)

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}.
post/v2/webhooks/{workbookId}/{sequenceId}

Request

  • Base URL
    https://api.sigmacomputing.com
  • Auth
    HTTP bearer

Path parameters

workbookIdstring required

The unique identifier of the workbook.

sequenceIdstring required

The unique identifier of the sequence.

Request body

object required

Response

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

traceIdstring

The action trace ID.

Changes

No recorded changes to this operation across all 1 revision of this API.