Get webhook event

webhook_events.retrieve(event_id) -> 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

event_id: String

ReturnsExpand Collapse

class 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: Time

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

require "vitable_connect"

vitable_connect = VitableConnect::Client.new(
  api_key: "My API Key",
  environment: "environment_1" # defaults to "production"
)

webhook_event = vitable_connect.webhook_events.retrieve("event_id")

puts(webhook_event)

{
  "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"
  }
}