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

# Luo webhook

> Rekisteröi URL-osoite, joka vastaanottaa webhook-tapahtumia

Rekisteröi HTTPS-osoite, joka vastaanottaa [webhook-tapahtumia](https://docs.anivahealth.com/fi/concepts/webhooks.md). API-avaimesi omistaa
webhookin. Se vastaanottaa tapahtuman vain kohteista, joita avaimesi voi lukea. Yksi API-avain voi omistaa enintään 5
webhookia.

> [!NOTE]
>
> Vaatii `webhooks_manage`-scopen.

## Pyyntö

### Runkoparametrit

**url** `string` *required*

HTTPS-osoite portissa 443, jolla on julkinen isäntänimi eikä tunnistetietoja. Aniva ei seuraa uudelleenohjauksia.

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

Vastaanotettavat [tapahtumatyypit](https://docs.anivahealth.com/fi/concepts/webhooks.md#tapahtumat), vähintään yksi. `["*"]` tarkoittaa kaikkia tyyppejä.
Arvoa `ping` ei voi listata.

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

1–5 sähköpostiosoitetta, joihin Aniva lähettää ilmoituksen, kun toimitukset epäonnistuvat toistuvasti.

**description** `string`

Vapaamuotoinen teksti omaan käyttöösi, enintään 500 merkkiä.

## Vastaus

Onnistuessaan API palauttaa tilakoodin `201 Created` sekä webhookin ja sen salaisuuden.

**secret** `string` *required*

Allekirjoitussalaisuus, `whsec_` ja base64. Aniva näyttää sen vain tässä vastauksessa. Katso [Vahvista
allekirjoitus](https://docs.anivahealth.com/fi/concepts/webhooks.md#vahvista-allekirjoitus).

**id** `string` *required*

Webhookin tunniste (UUID).

**url** `string` *required*

HTTPS-osoite, johon Aniva lähettää tapahtumat.

**description** `string`

Vapaamuotoinen teksti omaan käyttöösi. Voi olla `null`.

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

[Tapahtumatyypit](https://docs.anivahealth.com/fi/concepts/webhooks.md#tapahtumat), joita tämä webhook vastaanottaa. `*` tarkoittaa kaikkia tyyppejä.

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

Osoitteet, joihin Aniva lähettää sähköpostia, kun toimitukset epäonnistuvat toistuvasti.

**status** `string` *required*

`enabled` tai `disabled`.

**disabled\_at** `string`

ISO 8601 UTC -aikaleima, jolloin webhook poistettiin käytöstä. `null`, kun webhook on käytössä.

**disabled\_reason** `string`

Syy siihen, miksi webhook poistettiin käytöstä. Katso [Virheilmoitukset](https://docs.anivahealth.com/fi/concepts/webhooks.md#virheilmoitukset). `null`,
kun webhook on käytössä.

**failing\_since** `string`

ISO 8601 UTC -aikaleima, jolloin nykyinen epäonnistumisputki alkoi. `null`, kun viimeisin toimitus onnistui.

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

ISO 8601 UTC -aikaleima, jolloin edellinen salaisuus lakkaa allekirjoittamasta. `null`, kun vaihto ei ole käynnissä.

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

ISO 8601 UTC -aikaleima, jolloin webhook luotiin.

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

Viimeisimmän muutoksen ISO 8601 UTC -aikaleima.

## Virhevastaukset

| Tila | Kuvaus |
| - | - |
| `400` | Virheellinen pyyntö, esimerkiksi virheellinen URL, tuntematon tapahtumatyyppi, virheellinen `alert_emails` tai API-avain, joka ei voi omistaa webhookia. |
| `401` | Virheellinen API-avain. |
| `403` | API-avain puuttuu tai siltä puuttuu `webhooks_manage`-scope. |
| `409` | API-avaimesi omistaa jo 5 webhookia. |
| `500` | Sisäinen palvelinvirhe. |

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