Skip to content

WebHookRegistrationCreateRequest

Registers a web hook.

Kind: an object, used in requests.

FieldTypeRequiredDescription
typeWebHookTypeyesWhat the web hook reports on. Constraints: required (empty or whitespace-only strings are rejected).
urlstringyesThe URL to call. Constraints: format: url, required (empty or whitespace-only strings are rejected).
secretstringyesA secret of your choosing that every call is signed with (X-MT-WebHook-Signature, an HMAC-SHA256 of X-MT-WebHook-Timestamp and the body), so your endpoint can check the call came from Maitento. It’s never sent itself. Write-only. Constraints: minLength: 1, required (empty or whitespace-only strings are rejected).
headersmap<string, string>yesExtra HTTP headers to send with every call ({} for none). Values are write-only. Constraints: required (empty or whitespace-only strings are rejected).
{
"type": "AppProcess",
"url": "...",
"secret": "...",
"headers": {
"key": "..."
}
}