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

# Skapa webhook

> Registrera en URL som tar emot webhook-händelser

Registrera en HTTPS-URL som tar emot [webhook-händelser](https://docs.anivahealth.com/sv/concepts/webhooks.md). Din API-nyckel äger
webhooken. Den tar bara emot händelser för objekt som din nyckel kan läsa. En API-nyckel kan äga
högst 5 webhooks.

> [!NOTE]
>
> Kräver scopet `webhooks_manage`.

## Förfrågan

### Body-parametrar

**url** `string` *required*

HTTPS-URL på port 443 med en publik värd och utan inloggningsuppgifter. Aniva följer inte omdirigeringar.

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

[Händelsetyper](https://docs.anivahealth.com/sv/concepts/webhooks.md#haendelser) att ta emot, minst en. `["*"]` innebär alla typer.
`ping` kan inte listas.

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

1 till 5 adresser som Aniva mejlar när leveranser fortsätter att misslyckas.

**description** `string`

Fritext för din egen referens, högst 500 tecken.

## Svar

Vid lyckat anrop returnerar API:et `201 Created` med webhooken och dess hemlighet.

**secret** `string` *required*

Signeringshemligheten, `whsec_` plus base64. Aniva visar den bara i det här svaret. Se [Verifiera
signaturen](https://docs.anivahealth.com/sv/concepts/webhooks.md#verifiera-signaturen).

**id** `string` *required*

Webhook-identifierare (UUID).

**url** `string` *required*

Den HTTPS-URL som Aniva skickar händelser till.

**description** `string`

Fritext för din egen referens. Kan vara `null`.

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

[Händelsetyper](https://docs.anivahealth.com/sv/concepts/webhooks.md#haendelser) som den här webhooken tar emot. `*` innebär alla typer.

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

Adresser som Aniva mejlar när leveranser fortsätter att misslyckas.

**status** `string` *required*

`enabled` eller `disabled`.

**disabled\_at** `string`

Tidpunkt i ISO 8601 UTC då webhooken inaktiverades. `null` medan den är aktiverad.

**disabled\_reason** `string`

Varför webhooken inaktiverades. Se [Felaviseringar](https://docs.anivahealth.com/sv/concepts/webhooks.md#felaviseringar). `null`
medan den är aktiverad.

**failing\_since** `string`

Tidpunkt i ISO 8601 UTC då den aktuella sviten av misslyckanden började. `null` när den senaste leveransen lyckades.

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

Tidpunkt i ISO 8601 UTC då den föregående hemligheten slutar signera. `null` när ingen rotation pågår.

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

Tidpunkt i ISO 8601 UTC då webhooken skapades.

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

Tidpunkt i ISO 8601 UTC för den senaste ändringen.

## Felsvar

| Status | Beskrivning |
| - | - |
| `400` | Ogiltig begäran, till exempel en felaktig URL, en okänd händelsetyp, ogiltig `alert_emails` eller en API-nyckel som inte kan äga en webhook. |
| `401` | Ogiltig API-nyckel. |
| `403` | Ingen API-nyckel, eller en API-nyckel utan scopet `webhooks_manage`. |
| `409` | Din API-nyckel äger redan 5 webhooks. |
| `500` | Internt serverfel. |

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