Ändra webhook

PATCH/api/v1/webhooks/{id}

Adress, händelser och beskrivning, eller stäng av och slå på den.

En webhook vars leveranser har misslyckats 100 gånger i rad stängs av. Slå på den igen med active: true när mottagaren fungerar.

Guide: webhooks →

Behörighet

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

Sökvägsparametrar

idstringkrävs: Webhookens id.

Kropp

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

urlstring: Adressen som tar emot händelserna (https, standardport, nåbar från internet).högst 2048 tecken
eventsarray<string>: 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.
activeboolean: false stänger av webhooken. true slår på den igen (och nollställer räkningen av misslyckade leveranser).

Svar

200 Webhooken efter ändringen.

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.

Fel

400: bad_request
401: unauthenticated invalid_key key_revoked key_expired key_inactive
402: payment_required
403: insufficient_scope forbidden workspace_suspended
404: not_found
415: unsupported_media_type
422: validation_failed
429: rate_limited
500: internal_error

Anrop

curl -X PATCH 'https://newsletter.qrona.se/api/v1/webhooks/5e2d9b7c-1a3f-4c6e-8d0b-2f4a6c8e0b1d' \
  -H "Authorization: Bearer $QRONA_NEWSLETTER_KEY" \
  -H "Content-Type: application/json" \
  -d '{"events":["contact.subscribed","contact.unsubscribed"],"active":true}'

Svar 200

{
  "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"
}