Skip to content
Vitable Docs Vitable Docs Vitable Docs
API Reference
Webhook Events

List webhook event deliveries

webhook_events.list_deliveries(event_id) -> WebhookEventListDeliveriesResponse { data }
GET/v1/webhook-events/{event_id}/deliveries

Retrieves all delivery attempts for a webhook event. Returns up to 100 deliveries. Each delivery includes a computed status field (Pending, In Progress, Delivered, or Failed).

ParametersExpand Collapse
event_id: String
ReturnsExpand Collapse
class WebhookEventListDeliveriesResponse { data }
data: Array[{ id, created_at, delivered_at, 6 more}]
id: String

Prefixed unique identifier for this delivery (e.g., wdlv_...).

created_at: Time

When this delivery record was created, in UTC.

formatdate-time
delivered_at: Time

When the delivery was successfully received, in UTC.

formatdate-time
failed_at: Time

When the delivery was marked as permanently failed, in UTC.

formatdate-time
failure_reason: String

Reason for failure, if applicable.

started_at: Time

When the delivery attempt started, in UTC.

formatdate-time
status: String

Current delivery status: Pending, In Progress, Delivered, or Failed.

subscription_id: String

The webhook subscription this delivery was sent to.

webhook_event_id: String

The webhook event this delivery belongs to.

List webhook event deliveries

require "vitable_connect"

vitable_connect = VitableConnect::Client.new(
  api_key: "My API Key",
  environment: "environment_1" # defaults to "production"
)

response = vitable_connect.webhook_events.list_deliveries("event_id")

puts(response)
{
  "data": [
    {
      "id": "wdlv_abc123def456",
      "webhook_event_id": "wevt_xyz789abc012",
      "subscription_id": "wsub_sub123def456",
      "status": "Delivered",
      "started_at": "2024-06-15T14:30:01Z",
      "delivered_at": "2024-06-15T14:30:02Z",
      "failed_at": null,
      "failure_reason": "",
      "created_at": "2024-06-15T14:30:00Z"
    },
    {
      "id": "wdlv_def456ghi789",
      "webhook_event_id": "wevt_xyz789abc012",
      "subscription_id": "wsub_sub456ghi789",
      "status": "Failed",
      "started_at": "2024-06-15T14:30:01Z",
      "delivered_at": null,
      "failed_at": "2024-06-15T14:30:05Z",
      "failure_reason": "max_attempts",
      "created_at": "2024-06-15T14:30:00Z"
    }
  ]
}
Returns Examples
{
  "data": [
    {
      "id": "wdlv_abc123def456",
      "webhook_event_id": "wevt_xyz789abc012",
      "subscription_id": "wsub_sub123def456",
      "status": "Delivered",
      "started_at": "2024-06-15T14:30:01Z",
      "delivered_at": "2024-06-15T14:30:02Z",
      "failed_at": null,
      "failure_reason": "",
      "created_at": "2024-06-15T14:30:00Z"
    },
    {
      "id": "wdlv_def456ghi789",
      "webhook_event_id": "wevt_xyz789abc012",
      "subscription_id": "wsub_sub456ghi789",
      "status": "Failed",
      "started_at": "2024-06-15T14:30:01Z",
      "delivered_at": null,
      "failed_at": "2024-06-15T14:30:05Z",
      "failure_reason": "max_attempts",
      "created_at": "2024-06-15T14:30:00Z"
    }
  ]
}