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

List webhook event deliveries

webhook_events.list_deliveries(strevent_id) -> WebhookEventListDeliveriesResponse
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: str
ReturnsExpand Collapse
class WebhookEventListDeliveriesResponse: …
data: List[Data]
id: str

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

created_at: datetime

When this delivery record was created, in UTC.

formatdate-time
delivered_at: Optional[datetime]

When the delivery was successfully received, in UTC.

formatdate-time
failed_at: Optional[datetime]

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

formatdate-time
failure_reason: str

Reason for failure, if applicable.

started_at: Optional[datetime]

When the delivery attempt started, in UTC.

formatdate-time
status: str

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

subscription_id: str

The webhook subscription this delivery was sent to.

webhook_event_id: str

The webhook event this delivery belongs to.

List webhook event deliveries

import os
from vitable_connect import VitableConnect

client = VitableConnect(
    api_key=os.environ.get("VITABLE_CONNECT_API_KEY"),  # This is the default and can be omitted
)
response = client.webhook_events.list_deliveries(
    "event_id",
)
print(response.data)
{
  "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"
    }
  ]
}