MCP tools

Create notification

Create a notification in the user's Home inbox, a sign-off request, a to-do, or a deferred-work item.

Tool name: create-notification.

Create a notification in the user's Home inbox, a sign-off request, a to-do, or a deferred-work item. Use SIGN_OFF when you have prepared a workflow execution that needs the user's approval before it runs: pass its workflowExecutionId, and approving the notification RUNS that execution. Use TODO for a task you want the user to remember, and DEFERRED for work you have parked for later. NEVER pass brandId/organizationId, the notification is scoped automatically to the current account context. The notification lands PENDING in the user's queue.

When to use

Create a Home-inbox notification. SIGN_OFF with a linked workflow execution turns a prepared execution into an approval the user can run. TODO / DEFERRED carry no execution. Scope is taken from the current account context automatically.

Access

PropertyValue
Required scopewrite
PublishesNo
Read-onlyNo
DestructiveNo
IdempotentNo
Open worldNo

Input

FieldTypeRequiredDescription
typestringYesSIGN_OFF for approval-gated work, TODO for a reminder, DEFERRED for parked work. One of SIGN_OFF, TODO, DEFERRED.
titlestringYesShort, user-facing headline for the notification. At most 200 characters.
bodystringNoOptional longer description of what needs sign-off or attention. At most 4000 characters.
workflowExecutionIdstring (uuid)NoFor SIGN_OFF only: the id of the pre-created workflow execution that approving this notification will run.
payloadobjectNoOptional structured JSON object the Home UI can render alongside the notification.

Output

FieldTypeRequiredDescription
idstringYes
typestringYes
statusstringYes
sourcestring | nullYes
titlestringYes
brandIdnumber | nullYes
organizationIdnumber | nullYes
workflowExecutionIdstring | nullYes

REST equivalent

MCP only. No REST operation does the same thing.

On this page