Webhook'lar
Webhook'u getir
Tek bir webhook getir
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"
}
Tek bir webhook al. Yanıt hiçbir zaman imzalama gizli anahtarını içermez.
webhooks_manage kapsamını gerektirir.İstek
Yol parametreleri
Yanıt
Başarılı olduğunda API, webhook ile birlikte200 OK döndürür.
Bu webhook’un aldığı olay türleri.
* tüm türler anlamına gelir.Webhook’un neden devre dışı bırakıldığı. Bkz. Hata bildirimleri. Etkin durumdayken
null.Mevcut başarısızlık serisinin başladığı ISO 8601 UTC zamanı. Son teslimat başarılı olduğunda
null.Önceki gizli anahtarın imzalamayı durduracağı ISO 8601 UTC zamanı. Anahtar döndürme devam etmiyorken
null.Hata yanıtları
| Durum | Açıklama |
|---|---|
400 | Geçersiz istek. error mesajına bak. |
401 | Geçersiz API anahtarı. |
403 | API anahtarı yok veya API anahtarında webhooks_manage kapsamı bulunmuyor. |
404 | Webhook bulunamadı veya başka bir API anahtarına ait. |
500 | Dahili sunucu hatası. |
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"
}