Webhooks

List webhooks

The workspace's webhook endpoints, with the outcome of the last delivery to each.

GEThttps://api.vidrys.com/v1/webhooks

Plan: Custom
Key: read
Rate cost: 1 unit

List webhooks

curl --request GET \
  --url "https://api.vidrys.com/v1/webhooks" \
  --header "Authorization: Bearer $VIDRYS_API_KEY"

200 · success

{
  "webhooks": [
    {
      "id": "9a8b7c6d-5e4f-4a3b-82c1-0d9e8f7a6b5c",
      "url": "https://hooks.acmeinvoicing.com/vidrys",
      "events": [
        "run.completed",
        "draft.ready"
      ],
      "is_active": true,
      "last_status": 200,
      "last_delivery_at": "2026-09-21T04:02:19Z",
      "created_at": "2026-09-12T11:20:44Z"
    }
  ]
}

Authorization

Sent as a header on every request.

Authorizationstringrequired

A Vidrys API key, sent as Bearer vidrys_sk_…. A read key is enough. See Authentication.

Response · 200

application/json

webhooksobject[]

The workspace's webhooks.

+Show child attributes

idstring

Webhook id.

urlstring

Where events are sent.

eventsstring[]

The events it receives.

Values:run.completeddraft.ready

is_activeboolean

False once it has been switched off after 15 consecutive failed deliveries.

last_statusintegernullable

HTTP status of the latest delivery attempt.

last_delivery_atstringnullable

When the latest attempt was made (ISO 8601).

created_atstring

When it was created (ISO 8601).

Errors

403 plan_feature_unavailable	The feature is on a higher plan. Bulk exports and webhooks are Custom-only.
401 unauthorized	No key was sent, or the key is unknown, revoked or expired, or the member who created it has left the workspace or been deactivated.
402 plan_required	The workspace's plan doesn't include API access. It's included on Grow, Scale and Custom.
403 workspace_not_approved	The workspace is still waiting for approval, or wasn't approved.
429 rate_limited	Too many requests this minute. Wait for the number of seconds in the `Retry-After` header, then retry.

Every code, and what to retry, is in Errors.