Skip to content

WebHookRegistrationUpdateRequest

Changes a web hook’s URL, secret or headers. Its type can’t change.

Kind: an object, used in requests.

FieldTypeRequiredDescription
urlstringyesThe URL to call. Constraints: format: url, required (empty or whitespace-only strings are rejected).
secretstring | nullA new secret to sign calls with (X-MT-WebHook-Signature). Null or omitted: the stored secret is kept. Constraints: minLength: 1.
headersmap<string, string | null> | nullThe complete set of headers the web hook has after the update: a name left out is removed, and {} clears them all. Values are write-only (responses show ********), so a value of null or ******** keeps the stored value for that name; any other string replaces it. Omitting headers (or sending null) leaves every header unchanged.
signedOnlyboolean | nullTrue stops a web hook registered before deliveries were signed from sending its secret in X-MT-WebHook-Secret: from then on its deliveries are only signed, like every web hook registered now. It can’t be undone, so false or omitted changes nothing.
{
"url": "...",
"secret": "...",
"headers": {
"key": "..."
},
"signedOnly": false
}