Webhooks
Skicka testhändelse
Skicka en ping-händelse till en 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."
}
Skicka en signerad
ping-händelse till en webhook, oavsett dess enabled_events. Anropet returnerar direkt.
Följ resultatet med Lista leveranser.
Kräver scopet
webhooks_manage.Förfrågan
Sökvägsparametrar
Svar
Om anropet lyckas returnerar API:et202 Accepted.
Felsvar
| Status | Beskrivning |
|---|---|
400 | Ogiltig förfrågan. Se error-meddelandet. |
401 | Ogiltig API-nyckel. |
403 | Ingen API-nyckel, eller en API-nyckel utan scopet webhooks_manage. |
404 | Webhooken hittades inte, eller så tillhör den en annan API-nyckel. |
409 | Webhooken är inaktiverad. Aktivera den först. |
500 | Internt serverfel. |
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."
}