Get webhook event

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

GET/v1/webhook-events/{event_id}

Retrieves a single webhook event by its prefixed ID. Returns 404 if the event does not exist or belongs to a different organization.

ParametersExpand Collapse

eventID: string

ReturnsExpand Collapse

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

Get webhook event

import VitableConnect from '@vitable-inc/vitable-connect';

const client = new VitableConnect({
  apiKey: process.env['VITABLE_CONNECT_API_KEY'], // This is the default and can be omitted
});

const webhookEvent = await client.webhookEvents.retrieve('event_id');

console.log(webhookEvent.data);

{
  "data": {
    "id": "wevt_abc123def456",
    "organization_id": "org_xyz789",
    "event_name": "enrollment.accepted",
    "resource_type": "enrollment",
    "resource_id": "enrl_sample123",
    "created_at": "2024-06-15T14:30:00Z"
  }
}

Returns Examples

{
  "data": {
    "id": "wevt_abc123def456",
    "organization_id": "org_xyz789",
    "event_name": "enrollment.accepted",
    "resource_type": "enrollment",
    "resource_id": "enrl_sample123",
    "created_at": "2024-06-15T14:30:00Z"
  }
}