Skapa webhook

POST/api/v1/webhooks

En ny webhook. Svaret har hemligheten som leveranserna signeras med – den visas bara nu.

Adressen måste vara https, på standardporten och nåbar från internet. Varje leverans är en POST med JSON och headern Qrona-Signature; svara 2xx inom tio sekunder. Läs mer i guiden om webhooks.

Guide: webhooks →

Behörighet

webhooks:write Ändra webhooks – personen bakom nyckeln måste vara administratör.

Kropp

JSON, Content-Type: application/json. Okända fält ger 422.

urlstringkrävs: Adressen som tar emot händelserna (https, standardport, nåbar från internet).högst 2048 tecken
eventsarray<string>krävs: Händelserna webhooken ska få: contact.subscribed (anmälan), contact.unsubscribed (avregistrering), contact.bounced (studs), contact.complained (skräppostanmälan).minst 1 · högst 4 st
descriptionstring | null: Vad webhooken är till för.högst 200 tecken
include_apiboolean: Skicka även ändringar som gjorts via API:t. Standard: false, så att en integration inte får höra om sina egna ändringar.

Göra om anropet

Skicka gärna headern Idempotency-Key (t.ex. ett uuid). Skickas samma anrop igen med samma nyckel inom 24 timmar kommer det första svaret tillbaka, utan att något görs två gånger. Batch och idempotens

Svar

201 Den nya webhooken, med hemligheten.

idstringkrävs
urlstringkrävs
descriptionstring | nullkrävs
eventsarray<string>krävs
include_apibooleankrävs
activebooleankrävs
disabled_reasonstring | nullkrävs: Varför webhooken stängdes av av sig själv (leveranserna misslyckades), eller null.
consecutive_failuresintegerkrävs: Misslyckade leveransförsök i rad.
last_success_atstring (tid, ISO 8601) | nullkrävs: Senaste lyckade leveransen.
last_failure_atstring (tid, ISO 8601) | nullkrävs: Senaste misslyckade försöket.
created_atstring (tid, ISO 8601)krävs: När webhooken skapades.
updated_atstring (tid, ISO 8601)krävs: När webhooken senast ändrades.
secretstringkrävs: Hemligheten som leveranserna signeras med (Qrona-Signature). Visas bara nu – spara den hos mottagaren.

Fel

400: bad_request
401: unauthenticated invalid_key key_revoked key_expired key_inactive
402: payment_required
403: insufficient_scope forbidden workspace_suspended
409: limit_reached idempotency_in_progress
415: unsupported_media_type
422: validation_failed idempotency_key_reused
429: rate_limited
500: internal_error

Anrop

curl -X POST 'https://newsletter.qrona.se/api/v1/webhooks' \
  -H "Authorization: Bearer $QRONA_NEWSLETTER_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://butik.se/wp-json/qrona/v1/webhook","events":["contact.unsubscribed","contact.bounced","contact.complained"],"description":"Avregistreringar till WooCommerce"}'

Svar 201

{
  "id": "5e2d9b7c-1a3f-4c6e-8d0b-2f4a6c8e0b1d",
  "url": "https://butik.se/wp-json/qrona/v1/webhook",
  "description": "Avregistreringar till WooCommerce",
  "events": [
    "contact.bounced",
    "contact.complained",
    "contact.unsubscribed"
  ],
  "include_api": false,
  "active": true,
  "disabled_reason": null,
  "consecutive_failures": 0,
  "last_success_at": "2026-10-19T08:31:00.000Z",
  "last_failure_at": null,
  "created_at": "2026-10-19T08:30:00.000Z",
  "updated_at": "2026-10-19T08:30:00.000Z",
  "secret": "whsec_…"
}