Overview

This node sends a Slack message when a trigger condition is met. It can upload a snapshot image and a video clip to Slack, then link to them in the notification.

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 alert when this condition evaluates to true. Conditional on `trigger_source` being `custom`.	trigger-condition	`null`	Yes
`enabled`	Notifications Enabled	`bool`	`true`	No
`slack_bot_token`	Bot token created from your Slack app.	`string`	`null`	Yes
`slack_channels`	Comma-separated list of channel IDs or #channel names to post messages to.	`string`	`null`	Yes
`subject`	Title of the Slack message. See node documentation for template variables.	`string`	`{{ source_name }} : {{ event_name }}`	Yes
`body`	Body of the Slack message. See node documentation for template variables.	`string`	`{{ event_description }}`	No
`include_snapshot`	Include 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 message. Specifying a Save Clip node will include the most recent clip from the node. 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 message. Accepted node type: `stream_webrtc_out`.	`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

Template Syntax

The following Template variables are available to use in 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

Slack App Setup

Create a new Slack app at https://api.slack.com/apps and choose From scratch.
Under OAuth & Permissions, add the following Bot Token Scopes:
- chat:write
- files:write
- channels:read (only needed if you use #channel names instead of IDs for public channels)
- groups:read (only needed if you use #channel names instead of IDs for private channels)
Install the app to your workspace and copy the Bot User OAuth Token (starts with xoxb-).
Invite the bot to the target channel in Slack (e.g. /invite @Lumeo Alerts).
Paste the bot token into slack_bot_token and the channel name/IDs into slack_channels.

Slack App Manifest

Use this app manifest to quickly configure the Slack app.

_display_information:
  name: Lumeo Alerts
features:
  bot_user:
    display_name: Lumeo Bot
    always_online: true
oauth_config:
  scopes:
    bot:
      - chat:write
      - files:write
      - channels:read
      - groups:read
settings:
  org_deploy_enabled: false
  socket_mode_enabled: false
  token_rotation_enabled: false