API Reference – WorkOS Docs

List Webhook Endpoints

Get a list of all of your existing webhook endpoints.

cURL

 curl "https://api.workos.com/webhook_endpoints" \
  --header "Authorization: Bearer sk_example_123456789"

GET

`/webhook_endpoints`

`Parameters`

`Returns` `object`

Create a Webhook Endpoint

Create a new webhook endpoint to receive event notifications.

cURL

 curl --request POST \
  --url "https://api.workos.com/webhook_endpoints" \
  --header "Authorization: Bearer sk_example_123456789" \
  --header "Content-Type: application/json" \
  -d @- <<'BODY'
    {
        "endpoint_url": "https://example.com/webhooks",
        "events": [
            "user.created",
            "dsync.user.created"
        ]
    }
BODY

POST

`/webhook_endpoints`

`Returns`

Delete a Webhook Endpoint

Delete an existing webhook endpoint.

cURL

 curl --request DELETE \
  --url "https://api.workos.com/webhook_endpoints/we_0123456789" \
  --header "Authorization: Bearer sk_example_123456789"

DELETE

List Webhook Endpoints

/webhook_endpoints

Parameters

before?: string

after?: string

limit?: number

order?: "normal" | "desc" | "asc"

Returns object

object: "list"

data: object[]

list_metadata: object

Create a Webhook Endpoint

/webhook_endpoints

endpoint_url: string

events: string[]

Returns

webhook_endpoint: object

Delete a Webhook Endpoint

/webhook_endpoints/:id

Parameters

id: string

Returns

empty: empty

`/webhook_endpoints`

`Parameters`

`Returns` `object`

`/webhook_endpoints`

`Returns`

`/webhook_endpoints/:id`

`Parameters`

`Returns`