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

# Vytvořit webhook

> Zaregistrovat URL pro příjem událostí webhooku

Zaregistruj HTTPS URL, která bude přijímat [události webhooků](https://docs.anivahealth.com/cs/concepts/webhooks.md). Vlastníkem
webhooku je tvůj API klíč. Přijímá události jen pro objekty, které tvůj klíč může číst. Jeden API klíč může vlastnit nejvýše 5
webhooků.

> [!NOTE]
>
> Vyžaduje scope `webhooks_manage`.

## Požadavek

### Parametry těla

**url** `string` *required*

HTTPS URL na portu 443 s veřejným hostitelem a bez přihlašovacích údajů. Aniva nesleduje přesměrování.

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

[Typy událostí](https://docs.anivahealth.com/cs/concepts/webhooks.md#udalosti) k příjmu, alespoň jeden. `["*"]` znamená všechny typy.
`ping` nelze uvést.

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

1 až 5 adres, na které Aniva pošle e-mail, když doručování opakovaně selhává.

**description** `string`

Volný text pro tvou vlastní poznámku, nejvýše 500 znaků.

## Odpověď

Při úspěchu API vrátí `201 Created` s webhookem a jeho tajným klíčem.

**secret** `string` *required*

Podpisový tajný klíč, `whsec_` a base64. Aniva ho zobrazí jen v této odpovědi. Viz [Ověření
podpisu](https://docs.anivahealth.com/cs/concepts/webhooks.md#overeni-podpisu).

**id** `string` *required*

Identifikátor webhooku (UUID).

**url** `string` *required*

HTTPS URL, na kterou Aniva posílá události.

**description** `string`

Volný text pro tvou vlastní poznámku. Může být `null`.

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

[Typy událostí](https://docs.anivahealth.com/cs/concepts/webhooks.md#udalosti), které tento webhook přijímá. `*` znamená všechny typy.

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

Adresy, na které Aniva posílá e-maily, když doručování opakovaně selhává.

**status** `string` *required*

`enabled` nebo `disabled`.

**disabled\_at** `string`

Čas v ISO 8601 UTC, kdy byl webhook vypnut. `null`, dokud je zapnutý.

**disabled\_reason** `string`

Proč byl webhook vypnut. Viz [Oznámení o selhání](https://docs.anivahealth.com/cs/concepts/webhooks.md#upozorneni-na-selhani). `null`,
dokud je zapnutý.

**failing\_since** `string`

Čas v ISO 8601 UTC, kdy začala aktuální série selhání. `null`, pokud poslední doručení uspělo.

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

Čas v ISO 8601 UTC, kdy předchozí tajný klíč přestane podepisovat. `null`, pokud neprobíhá rotace.

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

Čas v ISO 8601 UTC, kdy byl webhook vytvořen.

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

Čas poslední změny v ISO 8601 UTC.

## Chybové odpovědi

| Stav | Popis |
| - | - |
| `400` | Neplatný požadavek, například chybná URL, neznámý typ události, neplatné `alert_emails` nebo API klíč, který nemůže vlastnit webhook. |
| `401` | Neplatný API klíč. |
| `403` | Chybí API klíč nebo API klíč nemá scope `webhooks_manage`. |
| `409` | Tvůj API klíč už vlastní 5 webhooků. |
| `500` | Interní chyba serveru. |

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