Webhookok
Webhookok listázása
Az API-kulcsodhoz tartozó webhookok listázása
GET
/
api
/
v1
/
webhooks
curl --request GET \
--url https://anivahealth.com/api/v1/webhooks \
--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"
}
]
Az API-kulcsodhoz tartozó webhookok listázása, a legrégebbivel kezdve. A válasz soha nem tartalmaz aláíró
titkos kulcsot.
A
webhooks_manage scope szükséges hozzá.Kérés
Ez a végpont nem vár paramétereket.Válasz
Siker esetén az API200 OK válasszal egy webhookobjektumokból álló tömböt ad vissza.
Azok az eseménytípusok, amelyeket ez a webhook fogad. A
* minden típust jelent.Címek, amelyekre az Aniva e-mailt küld, ha a kézbesítések folyamatosan sikertelenek.
A webhook letiltásának oka. Lásd: Hibaértesítések.
null,
amíg engedélyezve van.Az aktuális hibasorozat kezdetének ISO 8601 UTC időpontja.
null, ha az utolsó kézbesítés sikeres volt.Az az ISO 8601 UTC időpont, amikor az előző titkos kulcsot már nem használja aláíráshoz.
null, ha nincs folyamatban kulcsrotáció.Hibaválaszok
| Státusz | Leírás |
|---|---|
401 | Érvénytelen API-kulcs. |
403 | Nincs API-kulcs, vagy az API-kulcsnak nincs webhooks_manage scope-ja. |
500 | Belső szerverhiba. |
curl --request GET \
--url https://anivahealth.com/api/v1/webhooks \
--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"
}
]
⌘I
curl --request GET \
--url https://anivahealth.com/api/v1/webhooks \
--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"
}
]