Skip to main content
POST
Partially updates an existing webhook subscription. This is a patch-style operation — only fields you include in the request body are modified; any field you omit (or send as null) retains its current value. At least one field must be provided. You can use this endpoint to change the callback URL, update the event list, toggle the subscription on or off, or update the description.
The source API uses POST (not PUT) for this update operation. Use the path POST /public/webhook/subscription/{SubscriptionId}.

Authorizations

X-MSS-API-APPID
string
header
required

Portal application identifier used as part of HMAC-authenticated API requests.

X-MSS-API-USERKEY
string
header
required

Portal user API key used together with the HMAC signature headers.

X-MSS-CUSTOM-DATE
string
header
required

Timestamp header included in the signed request to prevent replay attacks.

X-MSS-SIGNATURE
string
header
required

HMAC-SHA256 signature for the request, calculated over the canonical string defined in the authentication docs.

Headers

Accept
enum<string>
required

Accept Header

Available options:
application/json

Path Parameters

SubscriptionId
integer<int64>
required

Numeric ID of the webhook subscription to update. Must belong to the authenticated account; returns 400 if not found.

Body

application/json

Webhook Services

url
string

New HTTPS URL for the webhook endpoint. Must use the https:// scheme and resolve to a publicly routable host — private, loopback, and link-local addresses are rejected. Omit (null) to keep the current URL.

description
string

New human-readable label for this subscription. Send an empty string to clear the current description. Omit (null) to keep the current value. Trimmed before storage.

enabled
boolean

When false, the subscription is paused and no events will be delivered until re-enabled. Omit to leave the current state unchanged.

events
string[]

Replacement list of event-type names. When provided, completely replaces the existing event list. Omit to leave the current list unchanged.

Response

Success

Webhook subscription returned by the public webhook management API

subscriptionId
integer<int64>
required

Unique numeric identifier of the webhook subscription

url
string
required

HTTPS URL that receives webhook POST deliveries

enabled
boolean
required

Whether the subscription is enabled

events
string[]
required

Event names that trigger this subscription

description
string

Optional human-readable label for the subscription

secretKey
string

Signing secret used to verify webhook deliveries. Returned on create and update responses only; omitted from list responses.