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

# Secret rotieren

> Das Signatur-Secret eines Webhooks ersetzen

Erstelle ein neues Signing-Secret für einen Webhook. Das alte Secret signiert noch 24 Stunden weiter, bis
`previous_secret_expires_at`. Eine zweite Rotation innerhalb dieser Zeit beendet das älteste Secret sofort.

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

## Anfrage

### Pfadparameter

**id** `string` *required*

Webhook-Kennung (UUID).

### Body-Parameter

Der Body ist optional.

**revoke\_current\_secret\_now** `boolean` (default: false)

`true` beendet das aktuelle Secret sofort, zum Beispiel nach einem Leak.

## Antwort

Bei Erfolg gibt die API `200 OK` mit dem Webhook und seinem neuen 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. Siehe die `error`-Meldung. |
| `401` | Ungültiger API-Schlüssel. |
| `403` | Kein API-Schlüssel oder ein API-Schlüssel ohne den Scope `webhooks_manage`. |
| `404` | Webhook nicht gefunden oder er gehört zu einem anderen API-Schlüssel. |
| `500` | Interner Serverfehler. |

```bash cURL theme={null}
curl --request POST \
  --url https://anivahealth.com/api/v1/webhooks/4a6c8e0f-2b4d-4f6a-8c0e-2a4c6e8f0b1d/rotate-secret \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "revoke_current_secret_now": false
  }'
```

```json 200 theme={null}
{
  "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": "2026-10-17T10:00:00.000Z",
  "created_at": "2026-10-15T08:00:00.000Z",
  "updated_at": "2026-10-16T10:00:00.000Z",
  "secret": "whsec_MfKQ9r8GKYqrTwjUPD8ILPZIo2LaLaSw8L0qsE2bkS4="
}
```

```json 404 theme={null}
{
  "error": "Webhook not found"
}
```


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