DanskAdresseAPIv1
DAWAbrug denneVores V1Beta
v1

Ændr en webhook (URL, events, filtre, til/fra)

Angiv kun de felter, der skal ændres. enabled: false sætter webhooken på pause: hændelser holdes, mens den er på pause. enabled: true genoptager den (og nulstiller en automatisk slået fra webhook); holdte hændelser under 72 timer sendes da i rækkefølge, ældre markeres som udløbet. Svaret har så held_released og held_expired.

PATCH/v1/webhooks/{id}Pro

Godkendelse

Authorizationstringheaderpåkrævet

Din API-nøgle som Bearer-token.

Parametre

idstringpathpåkrævet

Webhookens id.

Indhold

application/json
urlstring<uri>

HTTPS-URL, vi sender POST-requests til.

højst 2048 tegn
eventsenum<string>[]

Event-typer, fx address.updated, eller * for alle.

enabledboolean

false = sæt på pause, true = genoptag.

filtersobject

Valgfrie ressource-filtre. Inden for et felt er det «eller», mellem felterne «og»; tomt objekt = alle hændelser. Konto-hændelser (invoice.*, quota.*, subscription.*, job.*) filtreres aldrig. En hændelse, hvor fx kommunen ikke kan afgøres, sendes ikke, når der filtreres på kommune. Højst 5000 værdier i alt.

Vis underfelter(4)
filters.bfe_numreinteger[]

BFE-numre (ejendomme).

filters.postnumrestring[]

Postnumre (4 cifre), fx 2100.

filters.adresse_idsstring<uuid>[]

Adresse- eller adgangsadresse-id’er (UUID).

filters.kommunekoderstring[]

Kommunekoder (4 cifre), fx 0101.

Kald

curl --request PATCH \
  --url "https://api.danskadresseapi.dk/v1/webhooks/<id>" \
  --header "Authorization: Bearer $API_NOEGLE" \
  --header "Content-Type: application/json" \
  --data '{
  "url": "https://example.com",
  "events": [
    "*"
  ]
}'
Prøv det
PATCH https://api.danskadresseapi.dk/v1/webhooks/%7Bid%7D

Svar

application/json

Den opdaterede webhook

idstring<uuid>
urlstring<uri>
eventsstring[]
secretstring

Signeringshemmeligheden — kun i svaret på oprettelsen.

statusenum<string>
Mulige værdier:activepausedauto_disabled
enabledboolean
filtersobject

Valgfrie ressource-filtre. Inden for et felt er det «eller», mellem felterne «og»; tomt objekt = alle hændelser. Konto-hændelser (invoice.*, quota.*, subscription.*, job.*) filtreres aldrig. En hændelse, hvor fx kommunen ikke kan afgøres, sendes ikke, når der filtreres på kommune. Højst 5000 værdier i alt.

Vis underfelter(4)
filters.bfe_numreinteger[]

BFE-numre (ejendomme).

filters.postnumrestring[]

Postnumre (4 cifre), fx 2100.

filters.adresse_idsstring<uuid>[]

Adresse- eller adgangsadresse-id’er (UUID).

filters.kommunekoderstring[]

Kommunekoder (4 cifre), fx 0101.

created_atstring<date-time>
auto_disabled_atstring<date-time> | null
consecutive_failuresinteger
200Eksempel
{
  "id": "00000000-0000-0000-0000-000000000000",
  "url": "…",
  "events": [
    "…"
  ],
  "secret": "…",
  "status": "active",
  "enabled": false,
  "filters": {
    "bfe_numre": [
      0
    ],
    "postnumre": [
      "…"
    ],
    "adresse_ids": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "kommunekoder": [
      "…"
    ]
  },
  "created_at": "2026-09-20T10:00:00.000Z",
  "auto_disabled_at": "2026-09-20T10:00:00.000Z",
  "consecutive_failures": 0
}
401Manglende nøgle
{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key."
  }
}