Send a test event

Queues a test event (test: true) for the webhook, signed with its real secret. Choose the type with { "event": "address.updated" }; otherwise the webhook's first event type is used. Delivered within about 10 seconds — see the result under deliveries.

POST/v1/webhooks/{id}/testPro

Authentication

Authorizationstringheaderrequired

Your API key as a Bearer token.

Parameters

idstringpathrequired

The webhook's id.

eventstringquery

The event type to test (alternative to event in the body; the body wins).

Body

application/json

eventstring

The event type to test, e.g. address.updated. Omitted = the webhook’s first event type.

Request

curl --request POST \
  --url "https://api.danskadresseapi.dk/v1/webhooks/<id>/test" \
  --header "Authorization: Bearer $API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "event": "address.updated"
}'

Try it

API keyUsed only for this request and remembered only in this tab. It is never logged.id · path · *event · queryBody (JSON)

POST https://api.danskadresseapi.dk/v1/webhooks/%7Bid%7D/test

Response

application/json

The test event has been queued

event_typestring

delivery_idstring<uuid>

202Eksempel

{
  "event_type": "…",
  "delivery_id": "00000000-0000-0000-0000-000000000000"
}

401Missing key

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key."
  }
}