Skip to navigation
API ReferenceEvents and Webhooks

Retrieve an event

Retrieve an event object. Events are available for up to 30 days.

The event’s data is rendered according to the API version at the time of its creation, as specified by the api_version attribute in the event object, rather than the current API version

Authentication

AuthorizationBearer
Authorization header using the Bearer scheme

Path parameters

event_idstringRequiredformat: "evt_.+"

Headers

X-Platform-IdstringOptional

The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.

Response

OK
idstringformat: "evt_.+"
platform_idstringformat: "pt_.+"
createddatetime
typestring
dataobject
api_versionstringOptionalRead-only

Errors

404
Not Found Error