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

# Crear webhook

> Registrar una URL que reciba eventos de webhook

Registra una URL HTTPS que recibe [eventos de webhook](https://docs.anivahealth.com/es/concepts/webhooks.md). Tu clave API es la
propietaria del webhook. Solo recibe un evento para los objetos que tu clave puede leer. Una clave
API puede tener como máximo 5 webhooks.

> [!NOTE]
>
> Requiere el scope `webhooks_manage`.

## Solicitud

### Parámetros del cuerpo

**url** `string` *required*

URL HTTPS en el puerto 443 con un host público y sin credenciales. Aniva no sigue redirecciones.

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

[Tipos de evento](https://docs.anivahealth.com/es/concepts/webhooks.md#eventos) que se recibirán, al menos uno. `["*"]` significa
todos los tipos. No se puede incluir `ping`.

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

De 1 a 5 direcciones a las que Aniva envía un correo cuando las entregas siguen fallando.

**description** `string`

Texto libre para tu propia referencia, máximo 500 caracteres.

## Respuesta

Si tiene éxito, la API devuelve `201 Created` con el webhook y su secreto.

**secret** `string` *required*

El secreto de firma, `whsec_` seguido de base64. Aniva solo lo muestra en esta respuesta. Consulta
[Verificar la firma](https://docs.anivahealth.com/es/concepts/webhooks.md#verificar-la-firma).

**id** `string` *required*

Identificador del webhook (UUID).

**url** `string` *required*

La URL HTTPS a la que Aniva envía los eventos.

**description** `string`

Texto libre para tu propia referencia. Puede ser `null`.

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

[Tipos de evento](https://docs.anivahealth.com/es/concepts/webhooks.md#eventos) que recibe este webhook. `*` significa todos los tipos.

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

Direcciones a las que Aniva envía un correo cuando las entregas siguen fallando.

**status** `string` *required*

`enabled` o `disabled`.

**disabled\_at** `string`

Instante ISO 8601 UTC en el que se desactivó el webhook. `null` mientras esté activado.

**disabled\_reason** `string`

Motivo por el que se desactivó el webhook. Consulta [Avisos de fallo](https://docs.anivahealth.com/es/concepts/webhooks.md#avisos-de-fallo). `null`
mientras esté activado.

**failing\_since** `string`

Instante ISO 8601 UTC en el que empezó la racha actual de fallos. `null` cuando la última entrega tuvo éxito.

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

Instante ISO 8601 UTC en el que el secreto anterior deja de firmar. `null` cuando no hay ninguna rotación en curso.

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

Instante ISO 8601 UTC en el que se creó el webhook.

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

Instante ISO 8601 UTC del último cambio.

## Respuestas de error

| Estado | Descripción |
| - | - |
| `400` | Solicitud no válida, por ejemplo, una URL incorrecta, un tipo de evento desconocido, `alert_emails` no válido o una clave API que no puede tener webhooks. |
| `401` | Clave API no válida. |
| `403` | Falta la clave API o la clave API no tiene el scope `webhooks_manage`. |
| `409` | Tu clave API ya tiene 5 webhooks. |
| `500` | Error interno 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.