Get webhook

GET/api/v1/webhooks/{id}

A webhook and how its deliveries are going.

Guide: webhooks →

Scope

webhooks:read Read webhooks – the person behind the key must be administrator.

Path parameters

idstringrequired: The webhook's ID.

Response

200 The webhook.

idstringrequired
urlstringrequired
descriptionstring | nullrequired
eventsarray<string>required
include_apibooleanrequired
activebooleanrequired
disabled_reasonstring | nullrequired: Why the webhook disabled itself (the deliveries failed), or null.
consecutive_failuresintegerrequired: Failed delivery attempts in a row.
last_success_atstring (time, ISO 8601) | nullrequired: The last successful delivery.
last_failure_atstring (time, ISO 8601) | nullrequired: The most recent failed attempt.
created_atstring (time, ISO 8601)required: When the webhook was created.
updated_atstring (time, ISO 8601)required: When the webhook was last changed.

Errors

401: unauthenticated invalid_key key_revoked key_expired key_inactive
402: payment_required
403: insufficient_scope forbidden workspace_suspended
404: not_found
429: rate_limited
500: internal_error

Request

curl 'https://newsletter.qrona.se/api/v1/webhooks/5e2d9b7c-1a3f-4c6e-8d0b-2f4a6c8e0b1d' \
  -H "Authorization: Bearer $QRONA_NEWSLETTER_KEY"

Response 200

{
  "id": "5e2d9b7c-1a3f-4c6e-8d0b-2f4a6c8e0b1d",
  "url": "https://butik.se/wp-json/qrona/v1/webhook",
  "description": "Unsubscriptions to 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"
}