WebHookRegistration
A web hook: a URL Maitento calls whenever something of one type changes, such as an interaction run or an uploaded file.
Kind: an object, used in responses.
Fields
Section titled “Fields”Every field is present in a response; empty ones are null.
| Field | Type | Description |
|---|---|---|
type | WebHookType | What the web hook reports on. |
url | string | The URL Maitento calls. |
signedOnly | boolean | Whether deliveries are only signed, with X-MT-WebHook-Timestamp and X-MT-WebHook-Signature. Every web hook registered now is. False is one registered before deliveries were signed: its deliveries also carry the secret itself in X-MT-WebHook-Secret, so its receiver goes on working. Update it with signedOnly: true once the receiver checks the signature; that can’t be undone. |
headers | map<string, string> | Extra HTTP headers sent with every call. Values are write-only: a response shows each as ********. |
tenantId | uuid | The id of the tenant it belongs to. |
id | uuid | The unique id. Use it in by-id routes and wherever another object refers to this one. |
dateCreated | datetime | When it was created, in UTC. |
dateUpdated | datetime | When it was last changed, in UTC. |
Example
Section titled “Example”{ "type": "AppProcess", "url": "...", "signedOnly": false, "headers": { "key": "..." }, "tenantId": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f", "id": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f", "dateCreated": "2026-10-26T12:00:00.0000000Z", "dateUpdated": "2026-10-26T12:00:00.0000000Z"}Where it’s used
Section titled “Where it’s used”webhooks.create(POST /web-hooks)webhooks.get(GET /web-hooks/by-id/{id})webhooks.list(GET /web-hooks)webhooks.update(PUT /web-hooks/by-id/{id})