Webhookit
Hae webhook
Hae yksi webhook
GET
/
api
/
v1
/
webhooks
/
{id}
curl --request GET \
--url https://anivahealth.com/api/v1/webhooks/4a6c8e0f-2b4d-4f6a-8c0e-2a4c6e8f0b1d \
--header 'x-api-key: YOUR_API_KEY'
{
"id": "4a6c8e0f-2b4d-4f6a-8c0e-2a4c6e8f0b1d",
"url": "https://partner.example.com/webhooks/aniva",
"description": "Production",
"enabled_events": [
"appointment.confirmed",
"appointment.results.completed",
"home_kit_order.results.completed"
],
"alert_emails": ["ops@partner.example.com"],
"status": "enabled",
"disabled_at": null,
"disabled_reason": null,
"failing_since": null,
"previous_secret_expires_at": null,
"created_at": "2026-10-15T08:00:00.000Z",
"updated_at": "2026-10-15T08:00:00.000Z"
}
{
"error": "Webhook not found"
}
Hae yksi webhook. Vastaus ei koskaan sisällä allekirjoitussalaisuutta.
Vaatii
webhooks_manage-scopen.Pyyntö
Polkuparametrit
Vastaus
Onnistuessaan API palauttaa tilakoodin200 OK sekä webhookin.
Tapahtumatyypit, joita tämä webhook vastaanottaa.
* tarkoittaa kaikkia tyyppejä.Osoitteet, joihin Aniva lähettää sähköpostia, kun toimitukset epäonnistuvat toistuvasti.
Syy siihen, miksi webhook poistettiin käytöstä. Katso Virheilmoitukset.
null,
kun webhook on käytössä.ISO 8601 UTC -aikaleima, jolloin nykyinen epäonnistumisputki alkoi.
null, kun viimeisin toimitus onnistui.ISO 8601 UTC -aikaleima, jolloin edellinen salaisuus lakkaa allekirjoittamasta.
null, kun vaihto ei ole käynnissä.Virhevastaukset
| Tila | Kuvaus |
|---|---|
400 | Virheellinen pyyntö. Katso error-viesti. |
401 | Virheellinen API-avain. |
403 | API-avain puuttuu tai siltä puuttuu webhooks_manage-scope. |
404 | Webhookia ei löytynyt, tai se kuuluu toiselle API-avaimelle. |
500 | Sisäinen palvelinvirhe. |
curl --request GET \
--url https://anivahealth.com/api/v1/webhooks/4a6c8e0f-2b4d-4f6a-8c0e-2a4c6e8f0b1d \
--header 'x-api-key: YOUR_API_KEY'
{
"id": "4a6c8e0f-2b4d-4f6a-8c0e-2a4c6e8f0b1d",
"url": "https://partner.example.com/webhooks/aniva",
"description": "Production",
"enabled_events": [
"appointment.confirmed",
"appointment.results.completed",
"home_kit_order.results.completed"
],
"alert_emails": ["ops@partner.example.com"],
"status": "enabled",
"disabled_at": null,
"disabled_reason": null,
"failing_since": null,
"previous_secret_expires_at": null,
"created_at": "2026-10-15T08:00:00.000Z",
"updated_at": "2026-10-15T08:00:00.000Z"
}
{
"error": "Webhook not found"
}
⌘I
curl --request GET \
--url https://anivahealth.com/api/v1/webhooks/4a6c8e0f-2b4d-4f6a-8c0e-2a4c6e8f0b1d \
--header 'x-api-key: YOUR_API_KEY'
{
"id": "4a6c8e0f-2b4d-4f6a-8c0e-2a4c6e8f0b1d",
"url": "https://partner.example.com/webhooks/aniva",
"description": "Production",
"enabled_events": [
"appointment.confirmed",
"appointment.results.completed",
"home_kit_order.results.completed"
],
"alert_emails": ["ops@partner.example.com"],
"status": "enabled",
"disabled_at": null,
"disabled_reason": null,
"failing_since": null,
"previous_secret_expires_at": null,
"created_at": "2026-10-15T08:00:00.000Z",
"updated_at": "2026-10-15T08:00:00.000Z"
}
{
"error": "Webhook not found"
}