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

# Obtener webhook

> Recuperar un webhook

Obtén un webhook. La respuesta nunca contiene el secreto de firma.

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

## Solicitud

### Parámetros de ruta

**id** `string` *required*

Identificador del webhook (UUID).

## Respuesta

Si tiene éxito, la API devuelve `200 OK` con el webhook.

**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. Consulta el mensaje de `error`. |
| `401` | Clave API no válida. |
| `403` | Falta la clave API o la clave API no tiene el scope `webhooks_manage`. |
| `404` | Webhook no encontrado o pertenece a otra clave API. |
| `500` | Error interno del servidor. |

```bash cURL theme={null}
curl --request GET \
  --url https://anivahealth.com/api/v1/webhooks/4a6c8e0f-2b4d-4f6a-8c0e-2a4c6e8f0b1d \
  --header 'x-api-key: YOUR_API_KEY'
```

```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": null,
  "created_at": "2026-10-15T08:00:00.000Z",
  "updated_at": "2026-10-15T08:00:00.000Z"
}
```

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


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