Tīmekļa aizķeres
Iegūt tīmekļa aizķeri
Iegūt vienu tīmekļa aizķeri
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"
}
Iegūsti vienu tīmekļa aizķeri. Atbilde nekad neietver parakstīšanas slepeno atslēgu.
Nepieciešams
webhooks_manage tvērums.Pieprasījums
Ceļa parametri
Atbilde
Veiksmīgas izpildes gadījumā API atgriež200 OK ar tīmekļa aizķeri.
Notikumu veidi, ko saņem šī tīmekļa aizķere.
* nozīmē visus veidus.Kāpēc tīmekļa aizķere tika atspējota. Skati Kļūmju paziņojumi.
null,
kamēr tā ir iespējota.ISO 8601 UTC laika brīdis, kad sākās pašreizējā kļūmju sērija.
null, ja pēdējā piegāde izdevās.ISO 8601 UTC laika brīdis, kad iepriekšējā slepenā atslēga pārstāj parakstīt.
null, ja nenotiek rotācija.Kļūdu atbildes
| Statuss | Apraksts |
|---|---|
400 | Nederīgs pieprasījums. Skati error ziņojumu. |
401 | Nederīga API atslēga. |
403 | Nav API atslēgas vai API atslēgai trūkst webhooks_manage tvēruma. |
404 | Tīmekļa aizķere nav atrasta vai pieder citai API atslēgai. |
500 | Iekšēja servera kļūda. |
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"
}