---
title: "Retrieve webhook message schema (Beta)"
method: GET
path: "/v2/webhooks/{workbookId}/{sequenceId}/schema"
tags: ["Webhooks"]
---

# Retrieve webhook message schema (Beta)

`GET /v2/webhooks/{workbookId}/{sequenceId}/schema`

## Request

- Base URL: `https://api.sigmacomputing.com`
- URL: `https://api.sigmacomputing.com/v2/webhooks/{workbookId}/{sequenceId}/schema`
- Auth: HTTP bearer

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](/docs/sigma-product-releases#beta-features) disclaimer.

To send data to this webhook, see the [/v2/webhooks/{workbookId}/{sequenceId}](webhooks) 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}`.
- The keys included in the response `variables` are the same JSON keys used in the POST body for [/v2/webhooks/{workbookId}/{sequenceId}](webhooks).

## Path parameters

- `workbookId` string, required
- `sequenceId` string, required

## Response `200`

The response body.

- WebhooksGetWebhookSchemaResponse200
  - `variables` object, required: Key-value pairs of the fields to send to a webhook.

---

[API](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api.md) - [All operations](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/revisions/fb6036208c49?raw)