Webhooks
Oppdater webhook
Endre, deaktiver eller aktiver en 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."
}
Endre en webhook. Send bare feltene du vil endre. Send
status: "enabled" for å
starte en deaktivert webhook på nytt. Se Feilvarsler.
Krever scopet
webhooks_manage.Forespørsel
Stiparametere
Body-parametere
Ny HTTPS-URL. Samme regler som ved Opprett.
Respons
Ved suksess returnerer API-et200 OK med den oppdaterte webhooken.
Hendelsestyper denne webhooken mottar.
* betyr alle typer.Hvorfor webhooken ble deaktivert. Se Feilvarsler.
null
mens den er aktivert.ISO 8601 UTC-tidspunkt da den forrige hemmeligheten slutter å signere.
null når ingen rotasjon pågår.Feilresponser
| Status | Beskrivelse |
|---|---|
400 | Ugyldig forespørsel. Se error-meldingen. |
401 | Ugyldig API-nøkkel. |
403 | Ingen API-nøkkel, eller en API-nøkkel uten webhooks_manage-scopet. |
404 | Webhook ikke funnet, eller den tilhører en annen API-nøkkel. |
409 | status: "enabled" på en webhook som Aniva har deaktivert. Kontakt Aniva for å aktivere den. |
500 | Intern serverfeil. |
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."
}