Notifications

Notifications trigger based on specific system events during route operations. They let you build communication workflows directly into your data model.

Event Triggers

Supported events include:

  • ON_SUCCESS
  • ON_ERROR
  • ON_AR_CREATED
  • ON_AR_APPROVED
  • ON_AR_REJECTED
  • ON_AR_CHANGE_REQUESTED

Notification Templates

A Notification Config consists of one or more Notification Templates. Each template defines who gets notified and what the message says.

1. Audience Matrix (AUDIENCE_MATRIX)

This TypeScript codeblock determines recipients and returns users and teams.

import { Params, ReturnType } from './data';

export function run(params: Params): ReturnType {
	return {
		users: [params.scope.data.record.owner_email],
		teams: ['uuid-of-finance-team']
	};
}

2. Message Subject (CEL)

Use CEL for concise, context-aware subjects such as:

  • "Project " + data.record.name + " was approved!"
  • "Invoice " + data.record.invoice_number + " is overdue"

3. Message Template (MESSAGE_TEMPLATE)

Use a TypeScript codeblock when the notification body needs richer formatting.

Delivery

Notifications can be delivered via email and in-app messaging depending on the configured channels.