> ## 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.

# Webhook aanmaken

> Een URL registreren die webhook-events ontvangt

Registreer een HTTPS-URL die [webhook-events](https://docs.anivahealth.com/nl/concepts/webhooks.md) ontvangt. Je API-sleutel is de eigenaar van de
webhook. Deze ontvangt alleen een event voor objecten die je sleutel kan lezen. Een API-sleutel kan maximaal 5
webhooks bezitten.

> [!NOTE]
>
> Vereist de scope `webhooks_manage`.

## Verzoek

### Bodyparameters

**url** `string` *required*

HTTPS-URL op poort 443 met een publieke host en zonder inloggegevens. Aniva volgt geen redirects.

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

[Eventtypen](https://docs.anivahealth.com/nl/concepts/webhooks.md#events) om te ontvangen, minimaal één. `["*"]` betekent elk type.
`ping` kan niet worden opgenomen.

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

1 tot 5 adressen waarnaar Aniva een e-mail stuurt wanneer afleveringen blijven mislukken.

**description** `string`

Vrije tekst voor eigen referentie, maximaal 500 tekens.

## Respons

Bij succes geeft de API `201 Created` terug met de webhook en het secret.

**secret** `string` *required*

Het signing secret, `whsec_` plus base64. Aniva toont dit alleen in deze response. Zie [De
handtekening verifiëren](https://docs.anivahealth.com/nl/concepts/webhooks.md#de-handtekening-verifieren).

**id** `string` *required*

Webhook-identifier (UUID).

**url** `string` *required*

De HTTPS-URL waarnaar Aniva events verstuurt.

**description** `string`

Vrije tekst voor eigen referentie. Kan `null` zijn.

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

[Eventtypen](https://docs.anivahealth.com/nl/concepts/webhooks.md#events) die deze webhook ontvangt. `*` betekent elk type.

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

Adressen waarnaar Aniva een e-mail stuurt wanneer afleveringen blijven mislukken.

**status** `string` *required*

`enabled` of `disabled`.

**disabled\_at** `string`

ISO 8601 UTC-tijdstip waarop de webhook is uitgeschakeld. `null` zolang deze is ingeschakeld.

**disabled\_reason** `string`

Waarom de webhook is uitgeschakeld. Zie [Foutmeldingen](https://docs.anivahealth.com/nl/concepts/webhooks.md#foutmeldingen). `null`
zolang deze is ingeschakeld.

**failing\_since** `string`

ISO 8601 UTC-tijdstip waarop de huidige reeks mislukkingen begon. `null` wanneer de laatste aflevering is geslaagd.

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

ISO 8601 UTC-tijdstip waarop het vorige secret niet meer wordt gebruikt om te ondertekenen. `null` wanneer er geen rotatie bezig is.

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

ISO 8601 UTC-tijdstip waarop de webhook is aangemaakt.

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

ISO 8601 UTC-tijdstip van de laatste wijziging.

## Foutresponsen

| Status | Beschrijving |
| - | - |
| `400` | Ongeldig verzoek, bijvoorbeeld een onjuiste URL, een onbekend eventtype, ongeldige `alert_emails` of een API-sleutel die geen webhook kan bezitten. |
| `401` | Ongeldige API-sleutel. |
| `403` | Geen API-sleutel, of een API-sleutel zonder de scope `webhooks_manage`. |
| `409` | Je API-sleutel bezit al 5 webhooks. |
| `500` | Interne serverfout. |

```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.