POST/v1/tables/{id}/webhooks

Create a table webhook

Creates a webhook for a table to receive selected record events. Supply events, webhookUrl, and flowId to configure the event types, destination URL, and associated flow. Each event must be RECORD_CREATED, RECORD_UPDATED, or RECORD_DELETED.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 3 body fields
idstringrequired
The identifier of the table to create a webhook for.

Webhook configuration for a table, including subscribed events, destination URL, and associated flow.

eventsarray<string>required
The table events to subscribe to: `RECORD_CREATED`, `RECORD_UPDATED`, or `RECORD_DELETED`.
flowIdstringrequired
The identifier of the flow associated with the webhook.
webhookUrlstringrequired
The URL to receive the webhook events.

1 status code
200Returns the created table webhook.

Error handling

The id path parameter must identify the table for the webhook. The body must include events, webhookUrl, and flowId; each events value must be RECORD_CREATED, RECORD_UPDATED, or RECORD_DELETED.