Skip to content

Reference / Webhooks

List webhooks

GET/api/v1/webhooks

The workspace's webhooks.

Guide: webhooks →

Scope

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

Response

200 All webhooks.

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

Errors