Webhook endpoints

Create a new webhook endpoint

Create an endpoint. The signing secret is returned in FULL here, once.

post/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

Request body

urlstring required

https endpoint URL

descriptionstring nullable

Optional label that helps you recognize this endpoint.

event_typesstring[]

Subscribed event types; empty = all events (wildcard).

event_naming'legacy' | 'current' nullable

Which spelling of the photo-mockup events this endpoint receives: 'current' (photo_mockup., photo_mockup_render.) or 'legacy' (2d_mockup., 2d_render.). The payload's kind follows. Omit it and the endpoint is pinned to the spelling event_types is written in: the family names for a list that subscribes to them, otherwise 'legacy', the spelling this contract publishes.

Example request

{
  "description": "Production render notifications",
  "event_types": [
    "render.succeeded",
    "render.failed"
  ],
  "url": "https://your-app.example.com/hooks/sudomock"
}

Response

Successful Response

idstring required

Unique identifier for the webhook endpoint.

urlstring required

The https URL that receives this endpoint's events.

secretstring required

FULL signing secret. Shown only once.

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_cb79146988c2f928cc0760c737c67368080948cdadf7a20c14311290682ee865",
  "updated_at": "2026-09-18T09:24:11.482713Z",
  "url": "https://your-app.example.com/hooks/sudomock"
}

Changes

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