Send to a webhook (Beta)

POST

/v2/webhooks/:workbookId/:sequenceId

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 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](/docs/sigma-product-releases#beta-features) disclaimer. To retrieve the expected request body fields before sending data, see the [/v2/webhooks/{workbookId}/{sequenceId}/schema](getwebhookschema) endpoint. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) 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

sequenceIdstringRequired

Request

The request body.

Response

The response body.

traceIdstring

The action trace ID.

$	curl -X POST https://api.sigmacomputing.com/v2/webhooks/workbookId/sequenceId \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'