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

# Crea un webhook

> Registra un URL que rebi esdeveniments de webhook

Registra un URL HTTPS que rep [esdeveniments de webhook](https://docs.anivahealth.com/ca/concepts/webhooks.md). La teva clau d'API és la propietària del
webhook. Només rep un esdeveniment per als objectes que la teva clau pot llegir. Una clau d'API pot tenir com a màxim 5
webhooks.

> [!NOTE]
>
> Requereix l'àmbit `webhooks_manage`.

## Sol·licitud

### Paràmetres del cos

**url** `string` *required*

URL HTTPS al port 443 amb un amfitrió públic i sense credencials. Aniva no segueix redireccions.

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

[Tipus d'esdeveniments](https://docs.anivahealth.com/ca/concepts/webhooks.md#esdeveniments) per rebre, com a mínim un. `["*"]` vol dir tots els tipus.
No es pot incloure `ping`.

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

D'1 a 5 adreces a les quals Aniva envia un correu electrònic quan els lliuraments continuen fallant.

**description** `string`

Text lliure per a la teva referència, de 500 caràcters com a màxim.

## Resposta

Si té èxit, l'API retorna `201 Created` amb el webhook i el seu secret.

**secret** `string` *required*

El secret de signatura, `whsec_` més base64. Aniva només el mostra en aquesta resposta. Consulta [Verifica la
signatura](https://docs.anivahealth.com/ca/concepts/webhooks.md#verifica-la-signatura).

**id** `string` *required*

Identificador del webhook (UUID).

**url** `string` *required*

L'URL HTTPS al qual Aniva envia els esdeveniments.

**description** `string`

Text lliure per a la teva referència. Pot ser `null`.

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

[Tipus d'esdeveniments](https://docs.anivahealth.com/ca/concepts/webhooks.md#esdeveniments) que rep aquest webhook. `*` vol dir tots els tipus.

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

Adreces a les quals Aniva envia un correu electrònic quan els lliuraments continuen fallant.

**status** `string` *required*

`enabled` o `disabled`.

**disabled\_at** `string`

Instant UTC ISO 8601 en què es va desactivar el webhook. `null` mentre està activat.

**disabled\_reason** `string`

Motiu pel qual es va desactivar el webhook. Consulta [Avisos d'error](https://docs.anivahealth.com/ca/concepts/webhooks.md#avisos-d-error). `null`
mentre està activat.

**failing\_since** `string`

Instant UTC ISO 8601 en què va començar la ratxa actual d'errors. `null` quan l'últim lliurament ha tingut èxit.

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

Instant UTC ISO 8601 en què el secret anterior deixa de signar. `null` quan no hi ha cap rotació en curs.

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

Instant UTC ISO 8601 en què es va crear el webhook.

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

Instant UTC ISO 8601 de l'últim canvi.

## Respostes d'error

| Estat | Descripció |
| - | - |
| `400` | Sol·licitud no vàlida, per exemple un URL incorrecte, un tipus d'esdeveniment desconegut, `alert_emails` no vàlid o una clau d'API que no pot tenir webhooks. |
| `401` | Clau d'API no vàlida. |
| `403` | Sense clau d'API, o una clau d'API sense l'àmbit `webhooks_manage`. |
| `409` | La teva clau d'API ja té 5 webhooks. |
| `500` | Error intern del servidor. |

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