> ## Documentation Index
> Fetch the complete documentation index at: https://docs.anivahealth.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Opret webhook

> Registrer en URL, der modtager webhook-hændelser

Registrer en HTTPS-URL, der modtager [webhookhændelser](https://docs.anivahealth.com/da/concepts/webhooks.md). Din API-nøgle ejer
webhooken. Den modtager kun en hændelse for objekter, som din nøgle kan læse. En API-nøgle kan højst
eje 5 webhooks.

> [!NOTE]
>
> Kræver scopet `webhooks_manage`.

## Forespørgsel

### Body-parametre

**url** `string` *required*

HTTPS-URL på port 443 med en offentlig vært og uden loginoplysninger. Aniva følger ikke omdirigeringer.

**enabled\_events** `string[]` *required*

[Hændelsestyper](https://docs.anivahealth.com/da/concepts/webhooks.md#haendelser), der skal modtages, mindst én. `["*"]` betyder alle typer.
`ping` kan ikke angives.

**alert\_emails** `string[]` *required*

1 til 5 adresser, som Aniva sender e-mail til, når leveringer bliver ved med at fejle.

**description** `string`

Fritekst til din egen reference, højst 500 tegn.

## Svar

Ved succes returnerer API'et `201 Created` med webhooken og dens hemmelighed.

**secret** `string` *required*

Signeringshemmeligheden, `whsec_` plus base64. Aniva viser den kun i dette svar. Se [Bekræft
signaturen](https://docs.anivahealth.com/da/concepts/webhooks.md#verificer-signaturen).

**id** `string` *required*

Webhookidentifikator (UUID).

**url** `string` *required*

Den HTTPS-URL, som Aniva sender hændelser til.

**description** `string`

Fritekst til din egen reference. Kan være `null`.

**enabled\_events** `string[]` *required*

[Hændelsestyper](https://docs.anivahealth.com/da/concepts/webhooks.md#haendelser), som denne webhook modtager. `*` betyder alle typer.

**alert\_emails** `string[]` *required*

Adresser, som Aniva sender e-mail til, når leveringer bliver ved med at fejle.

**status** `string` *required*

`enabled` eller `disabled`.

**disabled\_at** `string`

ISO 8601 UTC-tidspunkt for, hvornår webhooken blev deaktiveret. `null`, mens den er aktiveret.

**disabled\_reason** `string`

Hvorfor webhooken blev deaktiveret. Se [Fejlmeddelelser](https://docs.anivahealth.com/da/concepts/webhooks.md#fejlmeddelelser). `null`,
mens den er aktiveret.

**failing\_since** `string`

ISO 8601 UTC-tidspunkt for, hvornår den aktuelle række af fejl startede. `null`, når den seneste levering lykkedes.

**previous\_secret\_expires\_at** `string`

ISO 8601 UTC-tidspunkt for, hvornår den forrige hemmelighed stopper med at signere. `null`, når ingen rotation er i gang.

**created\_at** `string` *required*

ISO 8601 UTC-tidspunkt for, hvornår webhooken blev oprettet.

**updated\_at** `string` *required*

ISO 8601 UTC-tidspunkt for seneste ændring.

## Fejlsvar

| Status | Beskrivelse |
| - | - |
| `400` | Ugyldig forespørgsel, f.eks. en ugyldig URL, en ukendt hændelsestype, ugyldige `alert_emails` eller en API-nøgle, der ikke kan eje en webhook. |
| `401` | Ugyldig API-nøgle. |
| `403` | Ingen API-nøgle eller en API-nøgle uden scopet `webhooks_manage`. |
| `409` | Din API-nøgle ejer allerede 5 webhooks. |
| `500` | Intern serverfejl. |

```bash cURL theme={null}
curl --request POST \
  --url https://anivahealth.com/api/v1/webhooks \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "url": "https://partner.example.com/webhooks/aniva",
    "enabled_events": [
      "appointment.confirmed",
      "appointment.results.completed",
      "home_kit_order.results.completed"
    ],
    "alert_emails": [
      "ops@partner.example.com"
    ],
    "description": "Production"
  }'
```

```json 201 theme={null}
{
  "secret": "whsec_MfKQ9r8GKYqrTwjUPD8ILPZIo2LaLaSw8L0qsE2bkS4=",
  "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"
}
```

```json 400 theme={null}
{
  "error": "url must use https"
}
```

```json 409 theme={null}
{
  "error": "An API key can own at most 5 webhooks"
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.