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

# Criar webhook

> Registar um URL que recebe eventos de webhook

Regista um URL HTTPS que recebe [eventos de webhook](https://docs.anivahealth.com/pt/concepts/webhooks.md). A tua chave de API é a proprietária do
webhook. Este recebe um evento apenas para objetos que a tua chave consegue ler. Uma chave de API pode ter no máximo 5
webhooks.

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

## Pedido

### Parâmetros do corpo

**url** `string` *required*

URL HTTPS na porta 443 com um host público e sem credenciais. A Aniva não segue redirecionamentos.

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

[Tipos de eventos](https://docs.anivahealth.com/pt/concepts/webhooks.md#eventos) a receber, pelo menos um. `["*"]` significa todos os tipos.
`ping` não pode ser listado.

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

1 a 5 endereços para os quais a Aniva envia email quando as entregas continuam a falhar.

**description** `string`

Texto livre para a tua própria referência, no máximo 500 caracteres.

## Resposta

Em caso de sucesso, a API devolve `201 Created` com o webhook e o seu segredo.

**secret** `string` *required*

O segredo de assinatura, `whsec_` seguido de base64. A Aniva mostra-o apenas nesta resposta. Consulta [Verificar a
assinatura](https://docs.anivahealth.com/pt/concepts/webhooks.md#verificar-a-assinatura).

**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 |
| - | - |
| `400` | Pedido inválido, por exemplo um URL incorreto, um tipo de evento desconhecido, `alert_emails` inválidos ou uma chave de API que não pode ter um webhook. |
| `401` | Chave de API inválida. |
| `403` | Sem chave de API, ou uma chave de API sem o âmbito `webhooks_manage`. |
| `409` | A tua chave de API já tem 5 webhooks. |
| `500` | Erro interno do 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.