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

# Créer un webhook

> Enregistrer une URL qui reçoit les événements webhook

Enregistrer une URL HTTPS qui reçoit les [événements webhook](https://docs.anivahealth.com/fr/concepts/webhooks.md). Ta clé API possède le
webhook. Il ne reçoit un événement que pour les objets que ta clé peut lire. Une clé API peut posséder au maximum 5
webhooks.

> [!NOTE]
>
> Nécessite le scope `webhooks_manage`.

## Requête

### Paramètres du corps

**url** `string` *required*

URL HTTPS sur le port 443 avec un hôte public et sans identifiants. Aniva ne suit pas les redirections.

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

[Types d'événements](https://docs.anivahealth.com/fr/concepts/webhooks.md#evenements) à recevoir, au moins un. `["*"]` signifie tous les types.
`ping` ne peut pas être inclus.

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

1 à 5 adresses auxquelles Aniva envoie un e-mail lorsque les livraisons continuent d'échouer.

**description** `string`

Texte libre pour ta propre référence, 500 caractères maximum.

## Réponse

En cas de succès, l'API renvoie `201 Created` avec le webhook et son secret.

**secret** `string` *required*

Le secret de signature, `whsec_` suivi de base64. Aniva ne l'affiche que dans cette réponse. Voir [Vérifier la
signature](https://docs.anivahealth.com/fr/concepts/webhooks.md#verifier-la-signature).

**id** `string` *required*

Identifiant du webhook (UUID).

**url** `string` *required*

L'URL HTTPS vers laquelle Aniva envoie les événements.

**description** `string`

Texte libre pour ta propre référence. Peut être `null`.

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

[Types d'événements](https://docs.anivahealth.com/fr/concepts/webhooks.md#evenements) que ce webhook reçoit. `*` signifie tous les types.

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

Adresses auxquelles Aniva envoie un e-mail lorsque les livraisons continuent d'échouer.

**status** `string` *required*

`enabled` ou `disabled`.

**disabled\_at** `string`

Instant ISO 8601 UTC de désactivation du webhook. `null` tant qu'il est activé.

**disabled\_reason** `string`

Raison de la désactivation du webhook. Voir [Avis d'échec](https://docs.anivahealth.com/fr/concepts/webhooks.md#notifications-d-echec). `null`
tant qu'il est activé.

**failing\_since** `string`

Instant ISO 8601 UTC de début de la série d'échecs actuelle. `null` lorsque la dernière livraison a réussi.

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

Instant ISO 8601 UTC auquel le secret précédent cesse de signer. `null` lorsqu'aucune rotation n'est en cours.

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

Instant ISO 8601 UTC de création du webhook.

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

Instant ISO 8601 UTC de la dernière modification.

## Réponses d'erreur

| Statut | Description |
| - | - |
| `400` | Requête invalide, par exemple une URL incorrecte, un type d'événement inconnu, des `alert_emails` invalides ou une clé API qui ne peut pas posséder de webhook. |
| `401` | Clé API invalide. |
| `403` | Aucune clé API, ou une clé API sans le scope `webhooks_manage`. |
| `409` | Ta clé API possède déjà 5 webhooks. |
| `500` | Erreur interne du serveur. |

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