Skip to main content
PATCH

Authorizations

x-api-key
string
header
required

API key with sm_ prefix. Get your key at https://sudomock.com/dashboard/api-keys

Path Parameters

endpoint_id
string
required

Body

application/json

Partial update. Any subset of fields; all optional.

url
string | null
Required string length: 1 - 2048
description
string | null
Maximum string length: 255
event_types
enum<string>[] | null
Available options:
render.succeeded,
render.failed,
upload.succeeded,
video.succeeded,
video.failed,
2d_mockup.ready,
2d_mockup.rejected,
2d_mockup.failed,
2d_render.succeeded,
2d_render.failed,
photo_mockup.ready,
photo_mockup.rejected,
photo_mockup.failed,
photo_mockup_render.succeeded,
photo_mockup_render.failed,
webhook.test
enabled
boolean | null
event_naming
enum<string> | null

Re-pin the endpoint to 'current' or 'legacy' event names once its handler is ready for them.

Available options:
legacy,
current

Response

200 - application/json

Successful Response

Endpoint metadata with the secret MASKED (whsec_****<last4>).

id
string
required
Example:

"b5cd6284-f6a0-4cfc-94df-781353e30dfd"

url
string
required
Example:

"https://your-app.example.com/hooks/sudomock"

secret
string
required

Masked: whsec_****

Example:

"whsec_****e865"

enabled
boolean
required
Example:

true

created_at
string<date-time>
required
date-time
Example:

"2026-09-18T09:24:11.482713Z"

description
string | null
Example:

"Production render notifications"

event_types
string[]
Example:
event_naming
string
default:legacy

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

updated_at
string<date-time> | null
date-time
Example:

"2026-09-18T09:31:02.117845Z"