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

> Eine URL registrieren, die Webhook-Ereignisse empfängt

Registriere eine HTTPS-URL, die [Webhook-Events](https://docs.anivahealth.com/de/concepts/webhooks.md) empfängt. Dein API-Schlüssel besitzt den
Webhook. Er empfängt ein Event nur für Objekte, die dein Schlüssel lesen kann. Ein API-Schlüssel kann höchstens 5
Webhooks besitzen.

> [!NOTE]
>
> Erfordert den Scope `webhooks_manage`.

## Anfrage

### Body-Parameter

**url** `string` *required*

HTTPS-URL auf Port 443 mit öffentlichem Host und ohne Zugangsdaten. Aniva folgt keinen Weiterleitungen.

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

[Event-Typen](https://docs.anivahealth.com/de/concepts/webhooks.md#events), die empfangen werden sollen, mindestens einer. `["*"]` steht für alle Typen.
`ping` kann nicht angegeben werden.

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

1 bis 5 Adressen, an die Aniva eine E-Mail sendet, wenn Zustellungen wiederholt fehlschlagen.

**description** `string`

Freitext für deine eigene Referenz, höchstens 500 Zeichen.

## Antwort

Bei Erfolg gibt die API `201 Created` mit dem Webhook und seinem Secret zurück.

**secret** `string` *required*

Das Signatur-Secret, `whsec_` plus Base64. Aniva zeigt es nur in dieser Antwort an. Siehe [Signatur
prüfen](https://docs.anivahealth.com/de/concepts/webhooks.md#signatur-pruefen).

**id** `string` *required*

Webhook-Kennung (UUID).

**url** `string` *required*

Die HTTPS-URL, an die Aniva Events sendet.

**description** `string`

Freitext für deine eigene Referenz. Kann `null` sein.

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

[Event-Typen](https://docs.anivahealth.com/de/concepts/webhooks.md#events), die dieser Webhook empfängt. `*` steht für alle Typen.

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

Adressen, an die Aniva eine E-Mail sendet, wenn Zustellungen wiederholt fehlschlagen.

**status** `string` *required*

`enabled` oder `disabled`.

**disabled\_at** `string`

ISO-8601-UTC-Zeitpunkt, zu dem der Webhook deaktiviert wurde. `null`, solange er aktiviert ist.

**disabled\_reason** `string`

Warum der Webhook deaktiviert wurde. Siehe [Fehlerbenachrichtigungen](https://docs.anivahealth.com/de/concepts/webhooks.md#fehlerbenachrichtigungen). `null`,
solange er aktiviert ist.

**failing\_since** `string`

ISO-8601-UTC-Zeitpunkt, zu dem die aktuelle Serie von Fehlschlägen begonnen hat. `null`, wenn die letzte Zustellung erfolgreich war.

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

ISO-8601-UTC-Zeitpunkt, zu dem das vorherige Secret nicht mehr zum Signieren verwendet wird. `null`, wenn keine Rotation läuft.

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

ISO-8601-UTC-Zeitpunkt, zu dem der Webhook erstellt wurde.

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

ISO-8601-UTC-Zeitpunkt der letzten Änderung.

## Fehlerantworten

| Status | Beschreibung |
| - | - |
| `400` | Ungültige Anfrage, zum Beispiel eine ungültige URL, ein unbekannter Event-Typ, ungültige `alert_emails` oder ein API-Schlüssel, der keinen Webhook besitzen kann. |
| `401` | Ungültiger API-Schlüssel. |
| `403` | Kein API-Schlüssel oder ein API-Schlüssel ohne den Scope `webhooks_manage`. |
| `409` | Dein API-Schlüssel besitzt bereits 5 Webhooks. |
| `500` | Interner Serverfehler. |

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