Webhook

Webhook endpoints, event subscriptions, and delivery tracking.

Source: packages/db/src/schema/webhook.ts

Enums

EnumValues
webhook_statusactive, paused, disabled, failed
webhook_delivery_statuspending, success, failed, retrying

webhook

ColumnTypeNotes
idtextPK, prefix wh_
namevarchar(255)NOT NULL
urltextNOT NULL
secrettextNOT NULL
organization_idtextFK → organization.id, CASCADE
user_idtextFK → user.id, CASCADE
statuswebhook_statusdefault active
custom_headersjsonb
rate_limit_enabledbooleandefault true
max_requests_per_minuteintegerdefault 60
max_retriesintegerdefault 3
retry_backoff_multiplierintegerdefault 2
filtering_optionsjsonb
last_triggered_attimestamp
success_countintegerdefault 0
failure_countintegerdefault 0
consecutive_failuresintegerdefault 0
deleted_attimestamp
created_attimestamp
updated_attimestamp

webhook_event_subscription

ColumnTypeNotes
idtextPK, prefix whsub_
webhook_idtextFK → webhook.id, CASCADE
event_idtextNOT NULL
is_enabledbooleandefault true
created_attimestamp
updated_attimestamp

webhook_event

ColumnTypeNotes
idtextPK, prefix evt_
eventtextNOT NULL
payloadjsonbNOT NULL
sourcevarchar(100)NOT NULL
organization_idtextFK → organization.id, CASCADE
user_idtextFK → user.id, SET NULL
created_attimestamp

webhook_delivery

ColumnTypeNotes
idtextPK, prefix whde_
webhook_idtextFK → webhook.id, CASCADE
webhook_event_idtextFK → webhook_event.id, SET NULL
event_typetextNOT NULL
event_datajsonbNOT NULL
statuswebhook_delivery_statusdefault pending
request_urltextNOT NULL
request_headersjsonb
request_bodyjsonb
response_statusinteger
response_bodytext
response_headersjsonb
attempt_numberintegerdefault 1
max_attemptsintegerdefault 3
next_retry_attimestamp
last_attempt_attimestamp
error_messagetext
error_detailsjsonb
completed_attimestamp
duration_msinteger
created_attimestamp

webhook_delivery_attempt

ColumnTypeNotes
idtextPK, prefix whda_
webhook_delivery_idtextFK → webhook_delivery.id, CASCADE
attempt_numberintegerNOT NULL
statuswebhook_delivery_statusNOT NULL
response_statusinteger
response_bodytext
response_headersjsonb
duration_msinteger
error_messagetext
created_attimestamp

Was this page helpful?

Edit this page