API ReferenceEvents and Webhooks

Retrieve a webhook endpoint

Get a registered webhook endpoint by its Id.

Authentication

AuthorizationBearer
Authorization header using the Bearer scheme

Path parameters

webhook_endpoint_idstringRequiredformat: "whe_.+"

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: "whe_.+"
The unique identifier of the endpoint
endpoint_urlstring
The registered URL of the endpoint
subscribed_eventslist of strings
The events the endpoint is subscribed to
created_atdatetime
The date and time the endpoint was created
objectstringOptionalRead-only
The object type

Errors

404
Not Found Error