Playground

Playground

Webhook

/api/v1/integration/webhooks

An outbound webhook endpoint.

listgetcreateupdatedelete

Schema

FieldTypeNotes
id*uuidServer-assigned ULID with type prefix (e.g. per_…).
tenant_id*stringTenant scope — auto-stamped from the caller's JWT.
app_idstringApp scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present.
created_at*date-timeServer stamp.
updated_at*date-timeServer stamp; updated on every patch.
created_byuuidPerson id from the caller's JWT (sub).
updated_byuuidPerson id from the last writer's JWT (sub).
sourcestringProvenance tag — defaults to 'edm'.
source_typeenumfrontend | backend | server | system | apiWhere the write originated. Defaults to 'api'.
is_deletedbooleanSoft-delete flag. Excluded from default list queries.
deleted_atdate-timeStamped when soft-deleted; null otherwise.
deleted_byuuidPerson id who soft-deleted; null otherwise.
schema_versionnumberDocument schema version. Bumped on incompatible writes.
namestringHuman-readable webhook name.
directionstringoutbound = cPod pushes to url; inbound = external system calls cPod.
urlstringTarget URL (outbound) or callback URL (inbound).
event_typesjsonEvent type filters, e.g. rfp.created, rfp.status_changed.
signature_schemestringPayload signing scheme.
vault_pathstringVault KV v2 path where the HMAC secret lives; never stored inline.
headersjsonStatic custom headers (non-secret) sent with every delivery.
enabledbooleanWhether this webhook is active.
retry_policyjson{ maxAttempts, backoff: 'exponential', timeoutMs }
last_delivery_atdate-timeTimestamp of the last delivery attempt.
last_delivery_statusstringOutcome of the last delivery attempt.
consecutive_failuresnumberCount of consecutive delivery failures.
paused_atdate-timeTimestamp when the webhook was auto-paused after N consecutive failures.
connector_idstringID of the owning Connector, if this webhook is connector-owned.
tagsjsonFree-form tags.
versionnumberOptimistic concurrency version counter.
application_iduuidOwning application id.
secret_fingerprintstringHash of the signing secret; raw secret is never stored.
is_activebooleanWhether this webhook is active.

API

Loading manifest…