Skip to content
Vitable Docs Vitable Docs Vitable Docs
API Reference
Webhook Events

Get webhook event

webhook_events.retrieve(strevent_id) -> WebhookEventRetrieveResponse
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
event_id: str
ReturnsExpand Collapse
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).

Get webhook event

import os
from vitable_connect import VitableConnect

client = VitableConnect(
    api_key=os.environ.get("VITABLE_CONNECT_API_KEY"),  # This is the default and can be omitted
)
webhook_event = client.webhook_events.retrieve(
    "event_id",
)
print(webhook_event.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"
  }
}