Skip to content
Vitable Docs Vitable Docs Vitable Docs
API Reference

Webhook Events

List webhook events
webhook_events.list(**kwargs) -> PageNumberPage<WebhookEvent { id, created_at, event_name, 3 more } >
GET/v1/webhook-events
Get webhook event
webhook_events.retrieve(event_id) -> WebhookEventRetrieveResponse { data }
GET/v1/webhook-events/{event_id}
List webhook event deliveries
webhook_events.list_deliveries(event_id) -> WebhookEventListDeliveriesResponse { data }
GET/v1/webhook-events/{event_id}/deliveries
ModelsExpand Collapse
class WebhookEvent { id, created_at, event_name, 3 more }
id: String

Prefixed unique identifier for this webhook event (e.g., wevt_...).

created_at: Time

When the event occurred, in UTC.

formatdate-time
event_name: String

The event type, formatted as {resource}.{action} (e.g., enrollment.accepted).

organization_id: String

The organization this event belongs to.

resource_id: String

Prefixed ID of the affected resource. Use this to fetch the current state from the API.

resource_type: String

The type of resource affected (e.g., enrollment, employee).

class WebhookEventRetrieveResponse { data }

Response containing a single webhook event resource.

data: WebhookEvent { id, created_at, event_name, 3 more }
id: String

Prefixed unique identifier for this webhook event (e.g., wevt_...).

created_at: Time

When the event occurred, in UTC.

formatdate-time
event_name: String

The event type, formatted as {resource}.{action} (e.g., enrollment.accepted).

organization_id: String

The organization this event belongs to.

resource_id: String

Prefixed ID of the affected resource. Use this to fetch the current state from the API.

resource_type: String

The type of resource affected (e.g., enrollment, employee).

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.