Webhooki
Zaktualizuj webhook
Zmień, wyłącz lub włącz webhook
PATCH
/
api
/
v1
/
webhooks
/
{id}
curl --request PATCH \
--url https://anivahealth.com/api/v1/webhooks/4a6c8e0f-2b4d-4f6a-8c0e-2a4c6e8f0b1d \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"status": "enabled"
}'
{
"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-16T07:30:00.000Z"
}
{
"error": "Webhook not found"
}
{
"error": "Aniva disabled this endpoint. Contact Aniva to enable it."
}
Zmień webhook. Wyślij tylko pola, które chcesz zmienić. Wyślij
status: "enabled", aby
ponownie uruchomić wyłączony webhook. Zobacz Powiadomienia o błędach.
Wymaga zakresu
webhooks_manage.Żądanie
Parametry ścieżki
Parametry treści
Nowy adres URL HTTPS. Te same zasady co przy Tworzeniu.
Odpowiedź
W przypadku powodzenia API zwraca200 OK ze zaktualizowanym 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. |
409 | status: "enabled" dla webhooka wyłączonego przez Aniva. Skontaktuj się z Aniva, aby go włączyć. |
500 | Wewnętrzny błąd serwera. |
curl --request PATCH \
--url https://anivahealth.com/api/v1/webhooks/4a6c8e0f-2b4d-4f6a-8c0e-2a4c6e8f0b1d \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"status": "enabled"
}'
{
"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-16T07:30:00.000Z"
}
{
"error": "Webhook not found"
}
{
"error": "Aniva disabled this endpoint. Contact Aniva to enable it."
}
⌘I
curl --request PATCH \
--url https://anivahealth.com/api/v1/webhooks/4a6c8e0f-2b4d-4f6a-8c0e-2a4c6e8f0b1d \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"status": "enabled"
}'
{
"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-16T07:30:00.000Z"
}
{
"error": "Webhook not found"
}
{
"error": "Aniva disabled this endpoint. Contact Aniva to enable it."
}