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

# Listar webhooks

> Listar os webhooks que pertencem à tua chave de API

Lista os webhooks que pertencem à tua chave de API, mais antigos primeiro. A resposta nunca contém um segredo
de assinatura.

> [!NOTE]
>
> Requer o âmbito `webhooks_manage`.

## Pedido

Este endpoint não aceita parâmetros.

## Resposta

Em caso de sucesso, a API devolve `200 OK` com um array de objetos webhook.

**id** `string` *required*

Identificador do webhook (UUID).

**url** `string` *required*

O URL HTTPS para o qual a Aniva envia os eventos.

**description** `string`

Texto livre para a tua própria referência. Pode ser `null`.

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

[Tipos de eventos](https://docs.anivahealth.com/pt/concepts/webhooks.md#eventos) que este webhook recebe. `*` significa todos os tipos.

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

Endereços para os quais a Aniva envia email quando as entregas continuam a falhar.

**status** `string` *required*

`enabled` ou `disabled`.

**disabled\_at** `string`

Instante ISO 8601 UTC em que o webhook foi desativado. `null` enquanto estiver ativo.

**disabled\_reason** `string`

Motivo pelo qual o webhook foi desativado. Consulta [Avisos de falha](https://docs.anivahealth.com/pt/concepts/webhooks.md#avisos-de-falha). `null`
enquanto estiver ativo.

**failing\_since** `string`

Instante ISO 8601 UTC em que começou a sequência atual de falhas. `null` quando a última entrega teve sucesso.

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

Instante ISO 8601 UTC em que o segredo anterior deixa de assinar. `null` quando não há rotação em curso.

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

Instante ISO 8601 UTC em que o webhook foi criado.

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

Instante ISO 8601 UTC da última alteração.

## Respostas de erro

| Estado | Descrição |
| - | - |
| `401` | Chave de API inválida. |
| `403` | Sem chave de API, ou uma chave de API sem o scope `webhooks_manage`. |
| `500` | Erro interno do servidor. |

```bash cURL theme={null}
curl --request GET \
  --url https://anivahealth.com/api/v1/webhooks \
  --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"
  }
]
```


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