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

# Webhook létrehozása

> Webhook-eseményeket fogadó URL regisztrálása

Regisztrálj egy HTTPS URL-t, amely [webhookeseményeket](https://docs.anivahealth.com/hu/concepts/webhooks.md) fogad. A webhook a te
API-kulcsodhoz tartozik. Csak olyan objektumokról kap eseményt, amelyeket a kulcsod olvashat. Egy API-kulcsnak legfeljebb 5
webhookja lehet.

> [!NOTE]
>
> A `webhooks_manage` scope szükséges hozzá.

## Kérés

### Törzsparaméterek

**url** `string` *required*

HTTPS URL a 443-as porton, nyilvános hoszttal és hitelesítő adatok nélkül. Az Aniva nem követi az átirányításokat.

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

A fogadni kívánt [eseménytípusok](https://docs.anivahealth.com/hu/concepts/webhooks.md#esemenyek), legalább egy. A `["*"]` minden típust jelent.
A `ping` nem adható meg a listában.

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

1–5 cím, amelyre az Aniva e-mailt küld, ha a kézbesítések folyamatosan sikertelenek.

**description** `string`

Szabad szöveg saját hivatkozáshoz, legfeljebb 500 karakter.

## Válasz

Siker esetén az API `201 Created` státusszal adja vissza a webhookot és annak titkos kulcsát.

**secret** `string` *required*

Az aláíró titkos kulcs: `whsec_` és base64. Az Aniva csak ebben a válaszban jeleníti meg. Lásd: [Az aláírás
ellenőrzése](https://docs.anivahealth.com/hu/concepts/webhooks.md#alairas-ellenorzese).

**id** `string` *required*

Webhook-azonosító (UUID).

**url** `string` *required*

A HTTPS URL, amelyre az Aniva az eseményeket küldi.

**description** `string`

Szabad szöveg saját hivatkozáshoz. Lehet `null`.

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

Azok az [eseménytípusok](https://docs.anivahealth.com/hu/concepts/webhooks.md#esemenyek), amelyeket ez a webhook fogad. A `*` minden típust jelent.

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

Címek, amelyekre az Aniva e-mailt küld, ha a kézbesítések folyamatosan sikertelenek.

**status** `string` *required*

`enabled` vagy `disabled`.

**disabled\_at** `string`

A webhook letiltásának ISO 8601 UTC időpontja. `null`, amíg engedélyezve van.

**disabled\_reason** `string`

A webhook letiltásának oka. Lásd: [Hibaértesítések](https://docs.anivahealth.com/hu/concepts/webhooks.md#hibaertesitesek). `null`,
amíg engedélyezve van.

**failing\_since** `string`

Az aktuális hibasorozat kezdetének ISO 8601 UTC időpontja. `null`, ha az utolsó kézbesítés sikeres volt.

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

Az az ISO 8601 UTC időpont, amikor az előző titkos kulcsot már nem használja aláíráshoz. `null`, ha nincs folyamatban kulcsrotáció.

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

A webhook létrehozásának ISO 8601 UTC időpontja.

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

Az utolsó módosítás ISO 8601 UTC időpontja.

## Hibaválaszok

| Státusz | Leírás |
| - | - |
| `400` | Érvénytelen kérés, például hibás URL, ismeretlen eseménytípus, érvénytelen `alert_emails`, vagy olyan API-kulcs, amelyhez nem tartozhat webhook. |
| `401` | Érvénytelen API-kulcs. |
| `403` | Hiányzó API-kulcs, vagy `webhooks_manage` scope nélküli API-kulcs. |
| `409` | Az API-kulcsodhoz már 5 webhook tartozik. |
| `500` | Belső szerverhiba. |

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