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

# Creează un webhook

> Înregistrează un URL care primește evenimente webhook

Înregistrează un URL HTTPS care primește [evenimente webhook](https://docs.anivahealth.com/ro/concepts/webhooks.md). Cheia ta API deține
webhook-ul. Acesta primește un eveniment doar pentru obiectele pe care cheia ta le poate citi. O cheie API poate deține cel mult 5
webhook-uri.

> [!NOTE]
>
> Necesită scope-ul `webhooks_manage`.

## Cerere

### Parametri de corp

**url** `string` *required*

URL HTTPS pe portul 443, cu un host public și fără credențiale. Aniva nu urmărește redirecționările.

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

[Tipuri de evenimente](https://docs.anivahealth.com/ro/concepts/webhooks.md#evenimente) de primit, cel puțin unul. `["*"]` înseamnă toate tipurile.
`ping` nu poate fi inclus în listă.

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

Între 1 și 5 adrese la care Aniva trimite e-mailuri când livrările continuă să eșueze.

**description** `string`

Text liber pentru referința ta, de cel mult 500 de caractere.

## Răspuns

La succes, API-ul returnează `201 Created` cu webhook-ul și secretul său.

**secret** `string` *required*

Secretul de semnare, `whsec_` plus base64. Aniva îl afișează doar în acest răspuns. Vezi [Verifică
semnătura](https://docs.anivahealth.com/ro/concepts/webhooks.md#verifica-semnatura).

**id** `string` *required*

Identificatorul webhook-ului (UUID).

**url** `string` *required*

URL-ul HTTPS la care Aniva trimite evenimente.

**description** `string`

Text liber pentru referința ta. Poate fi `null`.

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

[Tipurile de evenimente](https://docs.anivahealth.com/ro/concepts/webhooks.md#evenimente) pe care le primește acest webhook. `*` înseamnă toate tipurile.

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

Adresele la care Aniva trimite e-mailuri când livrările continuă să eșueze.

**status** `string` *required*

`enabled` sau `disabled`.

**disabled\_at** `string`

Momentul ISO 8601 UTC în care webhook-ul a fost dezactivat. `null` cât timp este activ.

**disabled\_reason** `string`

Motivul pentru care webhook-ul a fost dezactivat. Vezi [Notificări de eșec](https://docs.anivahealth.com/ro/concepts/webhooks.md#notificari-de-esec). `null`
cât timp este activ.

**failing\_since** `string`

Momentul ISO 8601 UTC în care a început seria curentă de eșecuri. `null` când ultima livrare a reușit.

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

Momentul ISO 8601 UTC în care secretul anterior nu mai este folosit la semnare. `null` când nu este în curs nicio rotație.

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

Momentul ISO 8601 UTC în care webhook-ul a fost creat.

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

Momentul ISO 8601 UTC al ultimei modificări.

## Răspunsuri de eroare

| Status | Descriere |
| - | - |
| `400` | Cerere nevalidă, de exemplu un URL incorect, un tip de eveniment necunoscut, `alert_emails` nevalide sau o cheie API care nu poate deține un webhook. |
| `401` | Cheie API nevalidă. |
| `403` | Lipsă cheie API sau o cheie API fără scope-ul `webhooks_manage`. |
| `409` | Cheia ta API deține deja 5 webhook-uri. |
| `500` | Eroare internă de server. |

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