- API-referanse
- Webhooks
Webhooks
Administrer abonnementer på hendelser og se leveringslogg.
- POST
/v1/webhooksOpprett abonnement - GET
/v1/webhooks/{id}/leveranserLeveringslogg - POST
/v1/webhooks/{id}/leveranser/{hendelse_id}/sendSend hendelse på nytt
POST
/v1/webhooksOpprett abonnement
Registrerer en URL som skal motta hendelser. Svaret inneholder signeringshemmeligheten én gang.
Kropp (JSON)
urlstringpåkrevdHTTPS-URL. Vi sender en testhendelse ved opprettelse og krever 2xx.
hendelserstring[]påkrevdListe, eller «*» for alle. Jokertegn som «faktura.*» støttes.
filterobjectF.eks. «orgnr_liste» for virksomhetshendelser.
beskrivelsestringVises i dashbordet.
forespørsel
curl -X POST https://api.spireapi.com/v1/webhooks \
-H "Authorization: Bearer sk_test_…" -H "Content-Type: application/json" -d '{"url":"https://din.app/spire","hendelser":["faktura.*"]}' svar
{ "id": "whk_01JBXA2K", "url": "https://din.app/spire", "hendelser": ["faktura.*"], "hemmelighet": "whsec_8f3k2…", "status": "aktiv" } GET
/v1/webhooks/{id}/leveranserLeveringslogg
Alle leveringsforsøk med statuskode, svartid og neste gjenforsøk. Oppbevaring etter plan.
Stiparametre
idstringpåkrevdWebhook-ID.
Spørringsparametre
statusstring«levert», «feilet» eller «venter».
forespørsel
curl "https://api.spireapi.com/v1/webhooks/whk_01JBXA2K/leveranser?status=feilet" \
-H "Authorization: Bearer sk_test_…" svar
{
"data": [
{ "hendelse_id": "evt_01JBXB7", "type": "faktura.betalt", "forsok": 2, "status": "levert", "http_status": 200, "svartid_ms": 182, "levert": "2026-11-03T10:11:02Z" }
]
} POST
/v1/webhooks/{id}/leveranser/{hendelse_id}/sendSend hendelse på nytt
Leverer en hendelse på nytt, for eksempel etter at du har rettet en feil hos deg.
Stiparametre
idstringpåkrevdWebhook-ID.
hendelse_idstringpåkrevdHendelses-ID.
forespørsel
curl -X POST https://api.spireapi.com/v1/webhooks/whk_01JBXA2K/leveranser/evt_01JBXB7/send \
-H "Authorization: Bearer sk_test_…" svar
{ "hendelse_id": "evt_01JBXB7", "status": "venter", "neste_forsok": "2026-11-03T10:12:00Z" }