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

# Webhooks

> Få et HTTPS-kald fra Aniva, når en tid, en bestilling af et hjemmetestkit, dens resultater, et uploadet dokument, en lokation, en profil eller en forsendelse ændrer sig

En webhook er en HTTPS `POST`, som Aniva sender til din server, når noget ændrer sig. Du behøver ikke
at polle.

Hændelser er kompakte. De indeholder objekt-id'et, den nye status, en revision og den `url`, der skal læses. De
indeholder aldrig laboratorieværdier eller persondata. Læs `url` med din API-nøgle for at hente dataene.

## Hurtig opsætning

1. Byg et HTTPS-endpoint, der accepterer `POST` og svarer `2xx` inden for 15 sekunder.
2. Registrer det med [Opret webhook](https://docs.anivahealth.com/da/api/webhooks/create-webhook.md).
   Gem `secret` fra svaret. Aniva viser den kun én gang.
3. [Verificer signaturen](#verificer-signaturen) på hver forespørgsel.
4. Send en [testhændelse](https://docs.anivahealth.com/da/api/webhooks/send-test-event.md). Tjek resultatet i
   [Vis leveringer](https://docs.anivahealth.com/da/api/webhooks/list-deliveries.md).

Din API-nøgle skal have scopet `webhooks_manage`. Bed Aniva om at tilføje det. En webhook tilhører den
API-nøgle, der oprettede den, og en nøgle kan højst eje 5 webhooks.

## Hændelser

Du modtager kun en hændelse for objekter, din API-nøgle kan læse med det tilsvarende `GET`-endpoint.
Vælg typerne med `enabled_events`. Send `["*"]` for at modtage alle typer, også typer der tilføjes senere.

| Type | Hvornår den udløses |
| - | - |
| `appointment.created` | Tiden bliver synlig for dig. Sendes én gang pr. tid. |
| `appointment.pending` | Tiden skifter til `pending`. |
| `appointment.confirmed` | Tiden skifter til `confirmed`. |
| `appointment.blood_drawn` | Tiden skifter til `blood_drawn`. |
| `appointment.cancelled` | Tiden skifter til `cancelled`. |
| `appointment.rescheduled` | `scheduled_at` eller lokationen ændres. Sendes ikke, når tiden er `cancelled`. |
| `appointment.results.updated` | Resultaterne ændres. |
| `appointment.results.completed` | Resultaternes `status` skifter til `completed`. |
| `appointment.results.fault` | Resultaternes `status` skifter til `fault`. |
| `home_kit_order.created` | Ordren oprettes. Sendes én gang pr. ordre. |
| `home_kit_order.pending` | Ordren skifter til `pending`. |
| `home_kit_order.dispatched` | Ordren skifter til `dispatched`. |
| `home_kit_order.activated` | Ordren skifter til `activated`. |
| `home_kit_order.cancelled` | Ordren skifter til `cancelled`. |
| `home_kit_order.results.updated` | Resultaterne ændres. |
| `home_kit_order.results.completed` | Resultaternes `status` skifter til `completed`. |
| `home_kit_order.results.fault` | Resultaternes `status` skifter til `fault`. |
| `document.results.updated` | Resultaterne for et dokument, du har uploadet, ændres, eller dokumentet gemmes. `stored` er endelig: der følger ingen `document.results.completed`. |
| `document.results.completed` | Resultaternes `status` for et dokument, du har uploadet, skifter til `completed`. |
| `document.results.fault` | Resultaternes `status` for et dokument, du har uploadet, skifter til `fault`. |
| `document.deleted` | Et dokument, du har uploadet, slettes. Sendes til de endpoints, der modtog dets seneste resultathændelse. Ingen `url`. |
| `location.created` | Lokationen bliver synlig for dig: ny, aktiveret eller føjet til en gruppe, du kan læse. |
| `location.updated` | Et felt på lokationen ændres: navn, adresse, hjemmeside, åbningstider, billede. |
| `location.deactivated` | Du kan ikke længere læse lokationen. |
| `location.retail_prices.updated` | En offentliggjort pris for et panel eller en biomarkør på lokationen ændres. Kræver scopet `retail_prices_view`. |
| `profile.created` | Profilen bliver synlig for dig: ny eller føjet til en profilgruppe, du kan læse. |
| `profile.updated` | Et felt i [Hent profil](https://docs.anivahealth.com/da/api/profiles/get-profile.md) ændres. |
| `profile.deleted` | Profilen slettes, eller du kan ikke længere læse den. |
| `shipment.created` | Forsendelsen bliver synlig for dig. |
| `shipment.updated` | Et felt på forsendelsen ændres: sporing, scanninger, afhentning, noter, links. |
| `shipment.pending` | Forsendelsen skifter til `pending`. |
| `shipment.in_transit` | Forsendelsen skifter til `in_transit`. |
| `shipment.delivered` | Forsendelsen skifter til `delivered`. |
| `shipment.fault` | Forsendelsen skifter til `fault`. |
| `shipment.cancelled` | Forsendelsen skifter til `cancelled`. |
| `ping` | Du har sendt en testhændelse. Sendes altid, ikke en del af `enabled_events`. |

* En statushændelse udløses ved hvert skift til den status, også ved et skift tilbage. For eksempel
  sender et kit, der går fra `dispatched` tilbage til `pending`, `home_kit_order.pending`.
* Én ændring kan sende to hændelser med samme `status_revision`, for eksempel
  `appointment.confirmed` og `appointment.rescheduled`.
* `results.updated` udløses ved enhver ændring af resultaterne: en ny værdi, en rettelse, en fejl, et nyt
  eller udskiftet dokument eller en prøve, der forlader objektet. Den ankommer inden for få minutter efter den
  seneste ændring.
* `results.completed` og `results.fault` kommer altid sammen med en `results.updated` med samme
  `results_revision`. Resultater kan genåbnes og afsluttes igen, så du kan få endnu en
  `results.completed`.

Abonner på `results.updated` for at vise delvise resultater, eller på `results.completed` for kun at reagere på
endelige resultater.

`results.completed` følger resultatværdierne, ikke PDF'en. Rapport-PDF'en kan ankomme før eller
efter værdierne. Nogle laboratorier sender først en foreløbig PDF og erstatter den senere med den endelige
under samme dokument-`id`. Udskiftningen sender `results.updated`. Læs
`documents[].original_file_name` for at skelne mellem de to: Labor Quade afslutter en foreløbig rapport
(Vorbefund) med `_V` og den endelige rapport (Endbefund) med `_E`, for eksempel
`7642100312_B0012_FA_E.pdf`.

Lokations-, profil- og forsendelseshændelser ankommer inden for få minutter. Aniva venter, til objektet ikke har
ændret sig i 2 minutter, så en række hurtige redigeringer sender én hændelse. Disse regler gælder også:

* Anonyme profiler sender ingen hændelser.
* En forsendelse sender ingen hændelse, når du mister adgangen til den.
* En ændring i forsendelsesstatus sender `shipment.updated` og hændelsen `shipment.<status>` med samme
  `revision`.

## Payload

| Felt | Beskrivelse |
| - | - |
| `id` | Hændelses-id (UUID). Samme som `webhook-id`-headeren. Forbliver det samme ved nyt forsøg og gensendelse. |
| `type` | Hændelsestype, for eksempel `appointment.confirmed`. |
| `timestamp` | Tidspunkt for ændringen som et ISO 8601 UTC-tidspunkt. Ikke tidspunktet for afsendelsen. |
| `data` | Det ændrede objekt. Strukturen afhænger af hændelsestypen. |

### Data for statushændelser

| Felt | Beskrivelse |
| - | - |
| `object` | `appointment` eller `home_kit_order`. |
| `id` | Id (UUID) for tiden eller hjemmetestkit-ordren. |
| `url` | `/api/v1/appointments/{id}` eller `/api/v1/home-kit-orders/{id}`. |
| `status` | Status efter ændringen. |
| `previous_status` | Status før ændringen. `null` ved `created`. |
| `status_revision` | Tæller pr. objekt. Den stiger ved hver statusændring og kan springe numre over. |

```json appointment.confirmed theme={null}
{
  "id": "0b8e6f3a-2c4d-4e7f-9a1b-3c5d7e9f1a2b",
  "type": "appointment.confirmed",
  "timestamp": "2026-10-15T09:12:44.512Z",
  "data": {
    "object": "appointment",
    "id": "c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a",
    "url": "https://anivahealth.com/api/v1/appointments/c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a",
    "status": "confirmed",
    "previous_status": "pending",
    "status_revision": 2
  }
}
```

### Data for resultathændelser

| Felt | Beskrivelse |
| - | - |
| `object` | `appointment`, `home_kit_order` eller `document`. |
| `id` | Id (UUID) for tiden, hjemmetestkit-ordren eller dokumentet. |
| `url` | Objektets `/results`-rute, f.eks. `/api/v1/documents/{id}/results`. |
| `results_status` | `in_progress`, `completed` eller `fault`. Et dokument kan også være `stored`. |
| `previous_results_status` | `results_status` fra den forrige resultathændelse. `null` ved den første. |
| `results_revision` | Tæller pr. objekt. Den stiger ved hver resultatændring og kan springe numre over. |

```json home_kit_order.results.completed theme={null}
{
  "id": "6d2a9c4e-8f1b-4a3d-b5e7-0c2f4a6b8d1e",
  "type": "home_kit_order.results.completed",
  "timestamp": "2026-10-15T14:03:00.000Z",
  "data": {
    "object": "home_kit_order",
    "id": "d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a",
    "url": "https://anivahealth.com/api/v1/home-kit-orders/d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a/results",
    "results_status": "completed",
    "previous_results_status": "in_progress",
    "results_revision": 4
  }
}
```

### Data for hændelser om slettede dokumenter

`document.deleted` indeholder `object` (`document`), `id`, `previous_results_status` og
`results_revision`. Den har ingen `url`, fordi der ikke er noget tilbage at læse.

```json document.deleted theme={null}
{
  "id": "1c9e7a52-3f4b-4d8a-9e61-7b2c5d0f8a14",
  "type": "document.deleted",
  "timestamp": "2026-10-24T09:12:00.000Z",
  "data": {
    "object": "document",
    "id": "f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c",
    "previous_results_status": "completed",
    "results_revision": 3
  }
}
```

### Data for lokations-, profil- og forsendelseshændelser

| Felt | Beskrivelse |
| - | - |
| `object` | `location`, `profile` eller `shipment`. |
| `id` | Lokations- eller profil-id (UUID) eller forsendelsesreferencen. |
| `url` | `/api/v1/locations/{id}`, `/api/v1/locations/{id}/retail-prices`, `/api/v1/profiles/{id}` eller `/api/v1/shipments/{id}`. Udeladt ved `.deactivated` og `.deleted`. |
| `status` | Kun forsendelser. Status efter ændringen. |
| `previous_status` | Kun forsendelser. Status før ændringen. `null` ved `shipment.created`. |
| `revision` | Tæller pr. objekt på tværs af alle dets hændelser. Den kan springe numre over. Hændelser om udsalgspriser har deres egen tæller. |

```json shipment.in_transit theme={null}
{
  "id": "3f7c1a2b-9d4e-4b6a-8c5f-2e1d0a9b8c7d",
  "type": "shipment.in_transit",
  "timestamp": "2026-10-16T08:41:12.000Z",
  "data": {
    "object": "shipment",
    "id": "P2610164821",
    "url": "https://anivahealth.com/api/v1/shipments/P2610164821",
    "status": "in_transit",
    "previous_status": "pending",
    "revision": 3
  }
}
```

En `ping` indeholder `data.object` `webhook` og `data.id`, som er webhook-id'et.

## Verificer signaturen

Hændelser indeholder ingen data, men du bør stadig verificere hver enkelt. En gyldig signatur beviser, at
hændelsen kommer fra Aniva. Hver forespørgsel indeholder headerne `webhook-id`, `webhook-timestamp` (Unix-
sekunder) og `webhook-signature`.

1. Tag den rå request body. Verificer den, før du parser JSON'en.
2. Opbyg det signerede indhold `{webhook-id}.{webhook-timestamp}.{raw body}`.
3. Base64-dekod den del af din hemmelighed, der kommer efter `whsec_`. Brug den som nøgle.
4. Beregn HMAC-SHA256 for det signerede indhold, og kod det som base64.
5. Sammenlign det i konstant tid med hvert `v1,<signature>`-element i `webhook-signature`. Elementerne
   er adskilt af mellemrum. Ét match er nok.
6. Afvis forespørgslen, hvis `webhook-timestamp` afviger mere end 5 minutter fra dit ur.

```typescript Node.js theme={null}
import { createHmac, timingSafeEqual } from 'node:crypto';

export function verifyAnivaWebhook(rawBody: string, headers: Headers, secret: string): boolean {
  const id = headers.get('webhook-id') ?? '';
  const timestamp = headers.get('webhook-timestamp') ?? '';
  if (Math.abs(Date.now() / 1000 - Number(timestamp)) > 300) return false;

  const key = Buffer.from(secret.slice('whsec_'.length), 'base64');
  const expected = createHmac('sha256', key).update(`${id}.${timestamp}.${rawBody}`).digest();

  return (headers.get('webhook-signature') ?? '').split(' ').some((entry) => {
    const [version, signature = ''] = entry.split(',');
    const received = Buffer.from(signature, 'base64');
    return (
      version === 'v1' && received.length === expected.length && timingSafeEqual(received, expected)
    );
  });
}
```

Standarden er [Standard Webhooks](https://www.standardwebhooks.com). Der findes Standard Webhooks-biblioteker
til de fleste sprog, som klarer dette i ét kald.

### Roter hemmeligheden

Kald [Roter hemmelighed](https://docs.anivahealth.com/da/api/webhooks/rotate-secret.md) for at få en ny hemmelighed. I 24 timer
signerer Aniva med både den gamle og den nye hemmelighed, så udrul den nye inden da. Send
`revoke_current_secret_now: true` efter et læk for at stoppe den gamle hemmelighed med det samme.

## Levering

* Svar med `2xx` inden for 15 sekunder. Gem hændelsen, eller sæt den i kø, og behandl den senere.
* Brug en `https`-URL på port 443 med en offentlig vært. Aniva følger ikke omdirigeringer: en `3xx`
  tæller som en fejl.
* Levering sker mindst én gang og uden fast rækkefølge. Filtrer dubletter fra via `webhook-id`. Brug revisionerne til
  at ignorere en ældre hændelse.
* Svar med `410 Gone` for at stoppe hændelserne. Aniva deaktiverer webhooken med det samme.
* Aniva gemmer leveringer i 30 dage. Derefter kan du ikke vise eller sende dem igen.

### Nye forsøg

Et andet svar end `2xx`, en timeout eller en netværksfejl udløser et nyt forsøg. Hver hændelse får op til 10 forsøg
over omkring tre dage:

| Forsøg | Tid efter første forsøg |
| - | - |
| 2 | omkring 5 sekunder |
| 3 | omkring 5 minutter |
| 4 | omkring 35 minutter |
| 5 | omkring 2,5 timer |
| 6 | omkring 7,5 timer |
| 7 | omkring 17,5 timer |
| 8 | omkring 27,5 timer |
| 9 | omkring 51,5 timer |
| 10 | omkring 75,5 timer |

Efter forsøg 10 er leveringen `failed`. Send den igen med
[Send levering igen](https://docs.anivahealth.com/da/api/webhooks/resend-delivery.md). Den beholder det samme `webhook-id`.

### Fejlmeddelelser

Aniva sender en e-mail til webhookens `alert_emails`, når ingen levering er lykkedes i 24 timer, når en hændelse er
`failed`, og når webhooken deaktiveres. Efter 5 dage uden en vellykket levering deaktiverer Aniva
webhooken. En deaktiveret webhook modtager ingen nye hændelser, og dens ventende leveringer
annulleres.

| `disabled_reason` | Årsag |
| - | - |
| `Disabled by the partner` | Du sendte `status: "disabled"`. |
| `Disabled by Aniva` | Aniva deaktiverede webhooken. Kun Aniva kan aktivere den igen. |
| `The endpoint answered 410 Gone` | Dit endpoint svarede `410 Gone`. |
| `No successful delivery for 5 days` | Ingen levering lykkedes i 5 dage. |

For at starte igen skal du rette dit endpoint og sende `status: "enabled"` med
[Opdater webhook](https://docs.anivahealth.com/da/api/webhooks/update-webhook.md). Manglende hændelser sendes ikke
igen af sig selv. Send dem igen, eller læs den aktuelle tilstand med `GET`-endpointsene.

## Gentagne læsninger

Aniva gemmer svaret fra nogle `GET`-endpoints i kort tid. Når din API-nøgle sender den samme
forespørgsel igen inden for denne tid, får du det gemte svar. Du får ingen fejl, og body har det
samme format.

* **En enkelt post** (en forsendelse, en hjemmetestkit-ordre, en tid og resultaterne for de to sidstnævnte):
  Ved hvert kald tjekker Aniva, om posten er uændret. Hvis den er ændret, får du et nyt svar.
* **En liste** kan være ældre end sine poster, højst 5 minutter.

Brug webhook-hændelserne i tabellen for at få besked om en ændring med det samme.

| Endpoint | Gemmes i | Hændelser, der giver besked om en ændring |
| - | - | - |
| [Hent forsendelse](https://docs.anivahealth.com/da/api/shipments/get-shipment.md) | 60 minutter | `shipment.created`, `shipment.updated` |
| [Vis forsendelser](https://docs.anivahealth.com/da/api/shipments/list-shipments.md) | 5 minutter | `shipment.created`, `shipment.updated` |
| [Hent hjemmetestkit-ordre](https://docs.anivahealth.com/da/api/home-kit-orders/get-home-kit.md) | 60 minutter | `home_kit_order.created` og én hændelse pr. status, for eksempel `home_kit_order.activated` |
| [Hent resultater for hjemmetestkit-ordre](https://docs.anivahealth.com/da/api/home-kit-orders/get-results.md) | 60 minutter | `home_kit_order.results.updated`, `.completed`, `.fault` |
| [Vis hjemmetestkit-ordrer](https://docs.anivahealth.com/da/api/home-kit-orders/list-home-kits.md) | 5 minutter | de samme hændelser som for én hjemmetestkit-ordre |
| [Hent tid](https://docs.anivahealth.com/da/api/appointments/get-appointment.md) | 15 minutter | `appointment.created`, `appointment.rescheduled` og én hændelse pr. status, for eksempel `appointment.confirmed` |
| [Hent resultater for tid](https://docs.anivahealth.com/da/api/appointments/get-results.md) | 60 minutter | `appointment.results.updated`, `.completed`, `.fault` |
| [Vis tider](https://docs.anivahealth.com/da/api/appointments/list-appointments.md) | 5 minutter | de samme hændelser som for én tid |
| [Vis profiler](https://docs.anivahealth.com/da/api/profiles/list-profiles.md) | 5 minutter | `profile.created`, `profile.updated`, `profile.deleted` |

* Den samme forespørgsel vil sige den samme API-nøgle, det samme endpoint og de samme query-parametre. En anden
  side i en liste er en anden forespørgsel og får sit eget svar.
* Aniva gemmer kun et `200`-svar. En fejl gemmes aldrig.
* Tiden starter, når Aniva gemmer svaret. Et senere kald forlænger den ikke.
* Når din API-nøgle opretter, opdaterer, aktiverer eller annullerer noget, giver din næste læsning et nyt svar.
  Den næste læsning af den post med en anden af dine API-nøgler giver også et nyt svar.
* I et gemt svar for en forsendelse kan felterne `synced_at` og `updated_at` være ældre end i et
  nyt svar. Status, sporing og adresser er aktuelle.
* I et gemt svar med resultater kan et biomarkørnavn, en enhed eller en omregnet værdi være op til 60
  minutter gammel, efter at Aniva ændrer sit katalog. De målte værdier er aktuelle.
* Når Aniva opretter en webhook-hændelse for din webhook, giver din næste læsning af den post, dens
  resultater og dens lister et nyt svar. Læsningen efter en hændelse viser derfor altid ændringen.

### Svarheadere

Hvert svar fra disse endpoints til en gyldig API-nøgle indeholder disse headere:

| Header | Sendes med | Betydning |
| - | - | - |
| `Aniva-Webhook-Events` | Hvert svar | De webhook-hændelser, der dækker dette endpoint, adskilt af kommaer. |
| `Link` | Hvert svar | Adressen på denne side med `rel="help"`. |
| `Cache-Status` | Et `200`-svar | `Aniva; hit; ttl=3476` er et gemt svar. `ttl` er antallet af sekunder, indtil et nyt svar er tilgængeligt. `Aniva; fwd=miss; stored; ttl=3600` er et nyt svar, som Aniva lige har gemt. `Aniva; fwd=miss` er et nyt svar, som Aniva ikke gemte. |
| `Age` | Et gemt svar | Det gemte svars alder i sekunder. |
| `Cache-Control` | Et `200`-svar | `private, no-cache`. Gem ikke svaret i din egen cache i stedet for at kalde Aniva. |

```http theme={null}
HTTP/1.1 200 OK
Age: 124
Cache-Status: Aniva; hit; ttl=3476
Cache-Control: private, no-cache
Aniva-Webhook-Events: shipment.created, shipment.updated
Link: <https://docs.anivahealth.com/concepts/webhooks>; rel="help"
```

## God praksis

* **Frasorter dubletter.** Spring en hændelse over, hvis du allerede har behandlet dens `webhook-id`.
* **Brug revisionerne.** Gem den højeste `status_revision`, `results_revision` og `revision`
  pr. objekt. Ignorer en hændelse med en lavere værdi.
* **Hent `url`.** Hændelsen fortæller, at noget er ændret. `GET`-endpointet fortæller hvad.
* **Svar hurtigt.** Sæt hændelsen i kø, og svar med `2xx`, før du behandler den.
* **Afstem løbende.** Kør et fast job, der læser åbne objekter med `GET`-endpointsene. Polling er fortsat en
  gyldig reserveløsning. En gentagen læsning kan give et gemt svar, se [Gentagne læsninger](#gentagne-laesninger).
* **Test efter hver udrulning.** Brug [Send testhændelse](https://docs.anivahealth.com/da/api/webhooks/send-test-event.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.