v1

latestOpenAPI 3.0.32026-07-2650226215.9 KB

Webhook

Create a webhook

Registers a new HTTPS endpoint to receive event deliveries. OMS generates a signing secret (whsec_ prefix) that is returned once in this response and never again - store it in your secrets manager immediately. The endpoint starts receiving deliveries immediately after creation.

post/webhooks

Headers

Idempotency-Keystring required

Required on POST and PUT requests. Use a unique value per logical mutation attempt, for example a UUID.

Request body

urlstring required

HTTPS endpoint URL. HTTP is only accepted in local/sandbox mode.

eventsstring[]

Event types to subscribe to. Omit the field, pass [], ["*"], or ["ALL"] to subscribe to all events. Specific event type strings must match the catalog in the webhook delivery documentation.

Response

The request has succeeded and a new resource has been created as a result.

idstring

Public TypeID, e.g. txn_01h455vb4pex5vsknk084sn02q; legacy UUID suffixes are accepted until non-v7 rows are retired.

object'webhook'

Resource type discriminator. Always "webhook".

urlstring

HTTPS endpoint that OMS delivers event payloads to.

secretstring

Signing secret used to verify the Webhook-Signature header on incoming deliveries. Uses the whsec_ prefix (32 cryptographically random bytes, hex-encoded). Returned only on creation - it cannot be retrieved afterward. Store it in your secrets manager immediately.

eventsstring[]

Event types this endpoint subscribes to. An empty array means the endpoint receives all event types (wildcard). See the event catalog in the webhook delivery documentation for the full list of valid values.

enabledboolean

Whether OMS is actively delivering events to this endpoint. Set to false to pause deliveries without deleting the endpoint. OMS also sets this to false automatically if the endpoint returns 410 Gone.

complianceOnlyboolean required

When true, this endpoint receives compliance-only events (e.g. underReview) that are excluded from all regular partner webhooks (AML no-tipping-off). Can only be set via the admin API.

status'active' | 'disabled'

createdAtstring date-time

ISO 8601 UTC timestamp of when the webhook was registered.