Webhooki
Pobierz webhook
Pobierz jeden 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"
}
Pobierz jeden webhook. Odpowiedź nigdy nie zawiera sekretu podpisującego.
Wymaga zakresu
webhooks_manage.Żądanie
Parametry ścieżki
Odpowiedź
W przypadku powodzenia API zwraca200 OK wraz z webhookiem.
Typy zdarzeń odbierane przez ten webhook.
* oznacza wszystkie typy.Powód wyłączenia webhooka. Zobacz Powiadomienia o błędach.
null, gdy jest włączony.Czas w formacie ISO 8601 UTC rozpoczęcia bieżącej serii niepowodzeń.
null, gdy ostatnie dostarczenie się powiodło.Czas w formacie ISO 8601 UTC, kiedy poprzedni sekret przestanie podpisywać.
null, gdy nie trwa rotacja.Odpowiedzi z błędami
| Status | Opis |
|---|---|
400 | Nieprawidłowe żądanie. Zobacz komunikat error. |
401 | Nieprawidłowy klucz API. |
403 | Brak klucza API lub klucz API bez zakresu webhooks_manage. |
404 | Nie znaleziono webhooka lub należy on do innego klucza API. |
500 | Wewnętrzny błąd serwera. |
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"
}