Skip to content
Qrona Newsletter
Sign inCreate an account

Reference / Webhooks

Update webhook

PATCH/api/v1/webhooks/{id}

URL, events and description, or disable and enable it.

A webhook whose deliveries have failed 100 times in a row is disabled. Turn it back on with active: true when the receiver is working.

Guide: webhooks →

Scope

  • webhooks:write Edit webhooks – the person behind the key must be administrator.

Path parameters

idstringrequired
The webhook's ID.

Body

JSON, Content-Type: application/json. Unknown fields return 422.

urlstring
The URL that receives the events (https, standard port, reachable from the internet).at most 2048 characters
eventsarray<string>
The events the webhook should receive: contact.subscribed (sign-up), contact.unsubscribed (unsubscription), contact.bounced (bounce), contact.complained (spam complaint).at least 1 · at most 4
descriptionstring | null
What the webhook is for.at most 200 characters
include_apiboolean
Also send changes made via the API. Default: false, so that an integration is not told about its own changes.
activeboolean
false disables the webhook. true enables it again (and resets the count of failed deliveries).

Response

200 The webhook after the change.

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

400
bad_request
401
unauthenticatedinvalid_keykey_revokedkey_expiredkey_inactive
402
payment_required
403
insufficient_scopeforbiddenworkspace_suspended
404
not_found
415
unsupported_media_type
422
validation_failed
429
rate_limited
500
internal_error