Webhook endpoints

Retrieve a list of webhook endpoints

List every webhook endpoint on the account, with its URL, event types, and enabled state.

get/api/v1/webhook-endpoints

Request

  • Base URL: https://api.sudomock.com
  • URL: https://api.sudomock.com/api/v1/webhook-endpoints
  • Auth: API key in header x-api-key

Response

Successful Response

idstring required

Unique identifier for the webhook endpoint.

urlstring required

The https URL that receives this endpoint's events.

secretstring required

Masked: whsec_****<last4>

descriptionstring nullable

Your label for this endpoint.

event_typesstring[]

Event types this endpoint receives; an empty list means every event.

enabledboolean required

Whether this endpoint currently receives events.

event_namingstring

The event-name spelling this endpoint is pinned to: 'legacy' or 'current'.

created_atstring date-time required

Time the endpoint was created.

updated_atstring date-time nullable

Time the endpoint was last updated.

Example response

[
  {
    "created_at": "2026-09-18T09:24:11.482713Z",
    "description": "Production render notifications",
    "enabled": true,
    "event_naming": "legacy",
    "event_types": [
      "render.succeeded",
      "render.failed"
    ],
    "id": "b5cd6284-f6a0-4cfc-94df-781353e30dfd",
    "secret": "whsec_****e865",
    "updated_at": "2026-09-18T09:31:02.117845Z",
    "url": "https://your-app.example.com/hooks/sudomock"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.