SIsigmacomputing
Webhooks

Retrieve webhook message schema (Beta)

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

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.

Response

The response body.

variablesobject required

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

Changes

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