Skip to content
Vitable Docs Vitable Docs Vitable Docs
API Reference

Webhook Events

List webhook events
client.webhookEvents.list(WebhookEventListParams { created_after, created_before, event_name, 4 more } query?, RequestOptionsoptions?): PageNumberPage<WebhookEvent { id, created_at, event_name, 3 more } >
GET/v1/webhook-events
Get webhook event
client.webhookEvents.retrieve(stringeventID, RequestOptionsoptions?): WebhookEventRetrieveResponse { data }
GET/v1/webhook-events/{event_id}
List webhook event deliveries
client.webhookEvents.listDeliveries(stringeventID, RequestOptionsoptions?): WebhookEventListDeliveriesResponse { data }
GET/v1/webhook-events/{event_id}/deliveries
ModelsExpand Collapse
WebhookEvent { id, created_at, event_name, 3 more }
id: string

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

created_at: string

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).