Skip to main content
POST
Rate limit tier: general, 600 requests/min. See Rate limits. Sends one signed webhook.ping event to the webhook’s endpoint and answers how the endpoint responded. Use it to check that the endpoint is reachable and that it verifies signatures. The ping goes out once, without retries, whatever events the webhook subscribes to:
delivered is true when the endpoint answered 2xx. status_code is the status it answered, or null when it never answered: a timeout, a connection failure, or a hostname that did not resolve.

Authorizations

Authorization
string
header
required

API key issued from app.anyformat.ai/api-key. Send as Authorization: Bearer <key>.

Path Parameters

webhook_id
string
required

Response

Successful Response

delivered
boolean
required

Whether the endpoint answered with a 2xx status.

status_code
integer | null

The HTTP status the endpoint answered with. null when it did not answer.

Example:

200