v1

latestOpenAPI 3.0.32026-07-2650226215.9 KB

Webhook

Update a webhook

Partially updates a webhook. All fields are optional - only supplied fields are modified. To pause deliveries without deleting the endpoint, set enabled to false. To resume, set it back to true. The secret is not returned in update responses.

patch/webhooks/{id}

Path parameters

idstring required

Request body

urlstring

New HTTPS endpoint URL. HTTPS is required in non-local environments.

eventsstring[]

Replaces the full events subscription. Pass [], ["*"], or ["ALL"] to switch to a wildcard (all events) subscription.

enabledboolean

Set to false to pause deliveries; true to resume them.

Response

The request has succeeded.

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.