Skip to content
Vitable Docs Vitable Docs Vitable Docs
API Reference

Webhook Events

List webhook events
webhook_events.list(WebhookEventListParams**kwargs) -> SyncPageNumberPage[WebhookEvent]
GET/v1/webhook-events
Get webhook event
webhook_events.retrieve(strevent_id) -> WebhookEventRetrieveResponse
GET/v1/webhook-events/{event_id}
List webhook event deliveries
webhook_events.list_deliveries(strevent_id) -> WebhookEventListDeliveriesResponse
GET/v1/webhook-events/{event_id}/deliveries
ModelsExpand Collapse
class WebhookEvent: …
id: str

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

created_at: datetime

When the event occurred, in UTC.

formatdate-time
event_name: str

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

organization_id: str

The organization this event belongs to.

resource_id: str

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

resource_type: str

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

class WebhookEventRetrieveResponse: …

Response containing a single webhook event resource.

id: str

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

created_at: datetime

When the event occurred, in UTC.

formatdate-time
event_name: str

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

organization_id: str

The organization this event belongs to.

resource_id: str

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

resource_type: str

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

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.