Skip to content

Notifications -- Payload Format

Webhook payloads are delivered as JSON.

Payload Structure

  • hook_id → Identifier of the webhook configuration
  • rows → List of affected row IDs

Characteristics

  • Same payload is reused for retries
  • Payload does not include full row data
  • External systems are expected to fetch details through the API

Example

{
  "hook_id": "10023012",
  "rows": [
    123,
    456,
    789
  ]
}