Webhookok
Webhook lekérése
Egy webhook lekérése
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"
}
Kérj le egy webhookot. A válasz soha nem tartalmazza az aláíró titkos kulcsot.
A
webhooks_manage scope szükséges hozzá.Kérés
Útvonalparaméterek
Válasz
Siker esetén az API200 OK státusszal adja vissza a webhookot.
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 |
|---|---|
400 | Érvénytelen kérés. Lásd az error üzenetet. |
401 | Érvénytelen API-kulcs. |
403 | Hiányzó API-kulcs, vagy webhooks_manage scope nélküli API-kulcs. |
404 | A webhook nem található, vagy egy másik API-kulcshoz tartozik. |
500 | Belső szerverhiba. |
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"
}