Webhooks
Send Test Event
Send a ping event to a webhook
POST
/
api
/
v1
/
webhooks
/
{id}
/
ping
curl --request POST \
--url https://anivahealth.com/api/v1/webhooks/4a6c8e0f-2b4d-4f6a-8c0e-2a4c6e8f0b1d/ping \
--header 'x-api-key: YOUR_API_KEY'
{
"delivery_id": "7c9e1a3b-5d7f-4b2d-9e4a-6c8e0a2b4d6f"
}
{
"error": "The endpoint is disabled. Enable it first."
}
Send a signed
ping event to a webhook, whatever its enabled_events. The call returns at once.
Follow the result with List Deliveries.
Requires the
webhooks_manage scope.Request
Path parameters
string
required
Webhook identifier (UUID).
Response
On success, the API returns202 Accepted.
string
required
Identifier (UUID) of the delivery that sends the ping.
Error responses
| Status | Description |
|---|---|
400 | Invalid request. See the error message. |
401 | Invalid API key. |
403 | No API key, or an API key without the webhooks_manage scope. |
404 | Webhook not found, or it belongs to another API key. |
409 | The webhook is disabled. Enable it first. |
500 | Internal server error. |
curl --request POST \
--url https://anivahealth.com/api/v1/webhooks/4a6c8e0f-2b4d-4f6a-8c0e-2a4c6e8f0b1d/ping \
--header 'x-api-key: YOUR_API_KEY'
{
"delivery_id": "7c9e1a3b-5d7f-4b2d-9e4a-6c8e0a2b4d6f"
}
{
"error": "The endpoint is disabled. Enable it first."
}
⌘I
curl --request POST \
--url https://anivahealth.com/api/v1/webhooks/4a6c8e0f-2b4d-4f6a-8c0e-2a4c6e8f0b1d/ping \
--header 'x-api-key: YOUR_API_KEY'
{
"delivery_id": "7c9e1a3b-5d7f-4b2d-9e4a-6c8e0a2b4d6f"
}
{
"error": "The endpoint is disabled. Enable it first."
}