Skip to main content
POST
Ping a webhook
Requires scope: manage:webhooks — see Required scopes. Queues a synthetic PING event for a single registered webhook so you can validate your endpoint end-to-end — including the authentication header your handler expects.
Delivery is asynchronous. A 200 means the ping was accepted for delivery, not that your endpoint received it. Check your own logs to confirm arrival.

Authorizations

Headers

x-tenant-id
string<uuid>

Which tenant the request is scoped to, among those your token grants. Omit it when the token grants exactly one tenant; it is required when the token grants more than one. A supplied value must exactly match a tenant the token grants.

Absent when required, blank, malformed, or naming a tenant the token does not grant — each gets the same generic 403 forbidden, which reveals neither whether a tenant exists nor which ones you may use. Send the header once: a repeated header is rejected the same way.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

Path Parameters

webhookId
string
required

Unique webhook identifier

Response

Ping accepted for delivery

success
boolean

Indicates whether the request was successful