Overview

The node sends an Notification via Email or Push when a trigger condition is met. It can also send a link to live stream, attach a snapshot as well as any Clips saved Locally using Save Clip Node.

Inputs & Outputs

Inputs : 1, Media Format : Raw Video
Outputs : 1, Media Format: Raw Video
Output Metadata : None

Properties

Property	Description	Type	Default	Required
`trigger_source`	Send Notifications from events generated by other nodes or a Custom defined trigger. Options: Events from previous nodes (`built_in`); Custom Trigger (`custom`).	`enum`	`custom`	Yes
`trigger`	Send an alarm when this condition evaluates to true. Conditional on `trigger_source` being `custom`.	trigger-condition	`null`	Yes
`enabled`	Notifications Enabled	`bool`	`true`	No
`send_mode`	Default sends notifications via Lumeo's managed notification service; recipients and delivery channels are configured in your Lumeo account. Direct lets you specify recipient email addresses and your own SMTP server. Options: Default (`default`); Direct (`direct`).	`enum`	`default`	Yes
`notification_type`	Notification Type. Options: Email Notification (`email`); Push Notification (`push`). Conditional on `send_mode` being `direct`. Format: array of selected option values.	`string[]`	`email`	No
`to_email`	Recipient email address. Conditional on `send_mode` being `direct`.	`string`	`null`	Yes
`subject`	Subject or Title of the notification. See node documentation for details on template variables.	`string`	`{{ source_name }} : {{ event_name }}`	Yes
`body`	Body of the notification. See node documentation for details on template variables.	`string`	`{{ event_description }}`	No
`include_snapshot`	Attach a snapshot from the trigger time.	`bool`	`true`	No
`snapshot_object_types`	Select the object types to include in the snapshot. If not specified, entire frame will be sent. Conditional on `include_snapshot` being `true`.	model-labels	`null`	No
`media_node`	Attaches media from the specified node with the email. Specifying a Save Clip node will include the most recent clip from the node with the email. The node must be configured to store clips locally.	`string`	`null`	No
`livestream_node`	Enables including the live stream URL from the named WebRTC node with the email using `livestream_url` template variable. Accepted node type: `stream_webrtc_out`.	`string`	`null`	No
`use_custom_smtp_server`	Use your own SMTP Server? Conditional on `send_mode` being `direct`.	`bool`	`false`	No
`server`	SMTP server IP address. Conditional on `use_custom_smtp_server` being `true`.	`string`	`null`	Yes
`port`	Port of the SMTP Server. Conditional on `use_custom_smtp_server` being `true`.	`number`	`null`	Yes
`use_tls`	If enabled, a TLS socket will be used for the SMTP session. Your SMTP server must support the STARTTLS SMTP extension to use this. Conditional on `use_custom_smtp_server` being `true`.	`bool`	`true`	No
`from_email`	"From" email address. Conditional on `use_custom_smtp_server` being `true`.	`string`	`null`	Yes
`user`	Optional. Leave this and SMTP password empty to send without SMTP AUTH. Conditional on `use_custom_smtp_server` being `true`.	`string`	`null`	No
`password`	Your SMTP server must support the AUTH SMTP connection to use this. Conditional on `use_custom_smtp_server` being `true`.	`string`	`null`	No
`interval`	Min. time between consecutive notifications. Unit: seconds.	`float`	`10`	No
`max_media_wait_time`	Max. time to wait until a media clip is available. Unit: seconds.	`float`	`10`	No
`media_extensions`	Comma separated list of media extensions to attach when a Media node is specified. For example, 'mp4,jpg,png,gif'.	`string`	`mp4`	No
`use_camera_as_source`	Enable to report a linked camera as the source for camera streams and Universal bridge clips.	`bool`	`false`	No

Send Modes

Default — Notifications are emitted to Lumeo's managed notification service. Recipients and delivery channels (email and/or push) are configured in your Lumeo account, so the recipient email and SMTP server options are hidden. Snapshots and clips are uploaded to Lumeo Files and attached by reference: when both a clip and a snapshot are present, the snapshot is set as the clip's thumbnail and only the clip is attached; otherwise the snapshot is attached on its own. This is the recommended mode for new nodes.
Direct — The node delivers notifications itself: it sends email (via Lumeo's hosted relay or your own SMTP server) and/or push notifications based on the notification_type selection, to the recipients listed in to_email.

Template Syntax

The following Template variables are available to use in Email Subject and Body. The templates can be built using Jinja2 Template Syntax.

Variables available to the template:

Variable	Description
`meta`	Frame metadata. Contains keys like `nodes`, `objects`, and other custom metadata inserted by Custom function node.
`application_id`	The application ID of the deployment that produced this metadata.
`application_name`	The application name of the deployment that produced this metadata.
`deployment_id`	The deployment ID of the deployment that produced this metadata.
`deployment_name`	The deployment name of the deployment that produced this metadata.
`source_name`	The name of the source that produced this metadata.
`livestream_url`	The URL of the livestream.
`event_name`	Name of event(s) contained in this frame.
`event_description`	Description of events contained in this frame.

Example templates

Static text content:

Text content

Reference specific metadata:

Person detected on {{ source_name }}. View live stream at {{ livestream_url }}

Metadata reinserted as is:

{{ meta | tojson }}

Output Metadata

Node does not insert any output metadata; upstream metadata continues through the pipeline