> ## 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 oluştur

> Webhook olaylarını alan bir URL kaydet

[Webhook olaylarını](https://docs.anivahealth.com/tr/concepts/webhooks.md) alan bir HTTPS URL'si kaydet. Webhook, API anahtarına
aittir. Yalnızca anahtarının okuyabildiği nesneler için olay alır. Bir API anahtarı en fazla 5
webhook sahibi olabilir.

> [!NOTE]
>
> `webhooks_manage` kapsamını gerektirir.

## İstek

### Gövde parametreleri

**url** `string` *required*

443 portunda, herkese açık bir ana bilgisayar kullanan ve kimlik bilgisi içermeyen HTTPS URL'si. Aniva yönlendirmeleri takip etmez.

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

Alınacak [olay türleri](https://docs.anivahealth.com/tr/concepts/webhooks.md#olaylar), en az bir tane. `["*"]` tüm türler anlamına gelir.
`ping` listelenemez.

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

Teslimatlar sürekli başarısız olduğunda Aniva'nın e-posta göndereceği 1 ila 5 adres.

**description** `string`

Kendi referansın için serbest metin, en fazla 500 karakter.

## Yanıt

Başarılı olduğunda API, webhook ve gizli anahtarıyla birlikte `201 Created` döndürür.

**secret** `string` *required*

İmzalama gizli anahtarı, `whsec_` ve ardından base64. Aniva bunu yalnızca bu yanıtta gösterir. Bkz. [İmzayı
doğrula](https://docs.anivahealth.com/tr/concepts/webhooks.md#imzayi-dogrula).

**id** `string` *required*

Webhook kimliği (UUID).

**url** `string` *required*

Aniva'nın olayları gönderdiği HTTPS URL'si.

**description** `string`

Kendi referansın için serbest metin. `null` olabilir.

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

Bu webhook'un aldığı [olay türleri](https://docs.anivahealth.com/tr/concepts/webhooks.md#olaylar). `*` tüm türler anlamına gelir.

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

Teslimatlar sürekli başarısız olduğunda Aniva'nın e-posta gönderdiği adresler.

**status** `string` *required*

`enabled` veya `disabled`.

**disabled\_at** `string`

Webhook'un devre dışı bırakıldığı ISO 8601 UTC zamanı. Etkin durumdayken `null`.

**disabled\_reason** `string`

Webhook'un neden devre dışı bırakıldığı. Bkz. [Hata bildirimleri](https://docs.anivahealth.com/tr/concepts/webhooks.md#hata-bildirimleri). Etkin durumdayken
`null`.

**failing\_since** `string`

Mevcut başarısızlık serisinin başladığı ISO 8601 UTC zamanı. Son teslimat başarılı olduğunda `null`.

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

Önceki gizli anahtarın imzalamayı durduracağı ISO 8601 UTC zamanı. Anahtar döndürme devam etmiyorken `null`.

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

Webhook'un oluşturulduğu ISO 8601 UTC zamanı.

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

Son değişikliğin ISO 8601 UTC zamanı.

## Hata yanıtları

| Durum | Açıklama |
| - | - |
| `400` | Geçersiz istek; örneğin hatalı bir URL, bilinmeyen bir olay türü, geçersiz `alert_emails` veya webhook sahibi olamayan bir API anahtarı. |
| `401` | Geçersiz API anahtarı. |
| `403` | API anahtarı yok veya API anahtarında `webhooks_manage` kapsamı bulunmuyor. |
| `409` | API anahtarın zaten 5 webhook sahibi. |
| `500` | Dahili sunucu hatası. |

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