v2

latestOpenAPI 3.1.12026-08-0785394779.1 KB

Webhooks

Retrieve a webhook endpoint

Get a registered webhook endpoint by its Id.

get/webhooks/endpoints/{webhook_endpoint_id}

Path parameters

webhook_endpoint_idstring required

Example:whe_3b1333d87d9d4fd6ad83ba7f6b0e951a

Headers

X-Platform-Idstring

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

idstring required

The unique identifier of the endpoint

endpoint_urlstring required

The registered URL of the endpoint

subscribed_eventsstring[] required

The events the endpoint is subscribed to

created_atstring date-time required

The date and time the endpoint was created

objectstring

The object type

Example response

{
  "id": "whe_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "created_at": "2024-12-01T00:00:00Z"
}