API referenceWebhooks

Send a test event to a webhook

Send a test (ping) event to a webhook

Endpoint
POST https://api.dairo.app/v1/webhooks/{webhook}/ping

Delivers a synthetic webhook.ping event to this endpoint immediately and inline, regardless of which events it subscribes to, so you can confirm reachability and signature verification without waiting for live traffic. The ping is signed with the same X-Dairo-Signature scheme as a real delivery, letting a consumer exercise its verification path, but it is never written to the event ledger. The response reports delivered (true only on a 2xx response) and lastStatusCode, and the attempt is recorded in the deliveries log — though a ping row can never be redriven, so send a new ping to re-test. Rate limited to 30 pings per hour; requires the webhooks:write scope.

Scope: webhooks:write. Send the API key as a bearer token; Scopes lists what each one reaches.

Request

cURL
curl -X POST "https://api.dairo.app/v1/webhooks/webhook/ping" \
  -H "Authorization: Bearer $DAIRO_API_KEY"

Path parameters

NameTypeRequiredDescription
webhookstringyesThe webhook's ID.

Response

200 Success. Body: application/json, object.

200
{}

Errors

Every error has the same body, {"error": {"type", "code", "message", "param"}}; branch on code. Errors lists every code.

StatusMeaning
400The request is malformed or a value is invalid (invalid_request, invalid_domain, idempotency_key_mismatch).
401The API key is missing or invalid.
403The key lacks the scope this endpoint needs (scope_missing) or may not do this (not_permitted).
404No such resource in this account (resource_not_found).
429Rate limit, plan limit, budget or spend cap reached (rate_limited, plan_limit_reached, budget_exceeded, spend_cap_reached).
500An unexpected error; retry with backoff, then contact support (internal_error).

On this page