Notify

Sends a notification to targeted users.

The body config key uses the shared Rich Text HTML format and can contain system variables.

Type key

notify

Config keys

Key	Type	Required	Description
title	string	yes	Notification title using a validated rendered template.
body	string	yes	Rich-text notification body using a validated rendered template.
url	string | null	no	Optional target URL. If omitted, a URL is derived from the dispatching entity.
computed_targetables_workflow_node_index	integer | null	no	Workflow node index used by workflow-node targetable computation.
computed_targetables_system_variable	string | null	no	Key-only System Variable used for computed targetables.
computed_targetables_entity_select_field_ids	integer[] | null	no	Entity-select field IDs used for computed targetables.
exclude_executing_targetable	boolean	yes	Excludes the currently executing user from notification targets.
send_mail	boolean	yes	Sends notification additionally via email.
plain_email	boolean	yes	Sends email as plain text format.

Available computed targetable types

All of computed targetable types are available for notify Action type.

Example config

{
  "title": "Task overdue ({{ system.date }})",
  "body": "<p>Triggered by {{ system.user.email }}.</p>",
  "url": "https://tenant.example.com/tasks-2/executions",
  "computed_targetables_workflow_node_index": null,
  "computed_targetables_system_variable": null,
  "computed_targetables_entity_select_field_ids": null,
  "exclude_executing_targetable": true,
  "send_mail": true,
  "plain_email": false
}