Webhook Events

List webhook events

client.webhookEvents.list(?, ?): PageNumberPage<WebhookEvent { id, created_at, event_name, 3 more } >

GET/v1/webhook-events

Get webhook event

client.webhookEvents.retrieve(, ?): WebhookEventRetrieveResponse { data }

GET/v1/webhook-events/{event_id}

List webhook event deliveries

client.webhookEvents.listDeliveries(, ?): 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).

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

WebhookEventListDeliveriesResponse { data }

data: Array<Data>

id: string

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

created_at: string

When this delivery record was created, in UTC.

formatdate-time

delivered_at: string | null

When the delivery was successfully received, in UTC.

formatdate-time

failed_at: string | null

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

formatdate-time

failure_reason: string

Reason for failure, if applicable.

started_at: string | null

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.