Skip to main content
POST
/
api
/
v2
/
webhooks
/
{webhook_id}
/
ping
Ping a webhook
curl --request POST \
  --url https://agp.eu.hcompany.ai/api/v2/webhooks/{webhook_id}/ping \
  --header 'Authorization: Bearer <token>'
Sends a signed ping event to the webhook through the real delivery path (same signature headers, same URL safety checks) and returns your endpoint’s HTTP response synchronously. Use it to validate connectivity and signature verification end to end before relying on the webhook. The ping body has the standard event envelope with "type": "ping" and "data": {"webhook_id": "..."}. Pings bypass enabled_events filtering and are not retried. Returns the receiving endpoint’s status code.

Path parameters

webhook_id
string
required
The webhook’s id (UUID).

Examples

curl -X POST https://agp.eu.hcompany.ai/api/v2/webhooks/f47ac10b-58cc-4372-a567-0e02b2c3d479/ping \
  -H "Authorization: Bearer $HAI_API_KEY"
Response
{
  "response_status": 200
}

Errors

StatusCause
400The webhook URL is not https:// or does not resolve to a public address.
404Webhook not found or you don’t have access.
502The endpoint could not be reached (connection error or timeout).