Skip to main content

Webhooks Model

A webhook stores an event hook, destination url, optional delay, headers, and query parameters. Webhook operations are described separately; this model summary covers fields only. Header values may be sensitive and must not appear in examples.

Schema properties​

Schema: Webhook

NameTypeDescription
delayany—
disabled_reasonany—
disabled_untilstring | null—
external_idinteger | null—
external_id_sourceany—
headersany—
hookany—
idinteger | null—
query_paramsobject | array | null—
retry_on_failany—
transformerobject | null—
urlany—