Insites Docs Developers guide NotificationsNotifications Overview

Notifications Overview

Last updated on July 25, 2024.

Notifications are messages sent to Insites users (including admins) when an event is triggered. A message can be an email, SMS, or programmatic call to a 3rd party API.

Notifications can be delayed, and you can use Liquid, GraphQL, and trigger conditions to decide if a notification should be sent. For example, they are a mechanism used to welcome new users, follow up after they've added their first item, or reach out to them if they have been inactive for a while.

Supported notification types

Currently, we support three types of notifications:

  • Email
  • SMS
  • API call

Notifications directory

Depending on what type of notification you would like to define, you should have three subdirectories in your directory:

  • : contains all Email Notifications
  • : contains all SMS Notifications
  • : contains all API Call Notifications

Configuration

Each configuration can accept different properties, but some of the main concepts are common:

Property Description Default Example
to

Depending on the alert type, it is either:

  • an email address of the recipient (or comma-delimited list of emails)
  • mobile number of the recipient
  • endpoint for the API call
Accepts Liquid.		 n/a
delay The number of minutes the notification should be delayed. You could use Liquid to calculate the number. For example, you could schedule an email to be sent the next day at 10 am time: 0 2
enabled Boolean; defines whether an alert should be invoked. If false, it will be ignored. true false
locale Liquid code which evaluates to the desired language code, which should be used for translations and date format.
trigger_condition Liquid condition to control whether a notification should be sent. The only value that allows notification to be delivered is . If you skip it, the notification will be sent (unless enabled is false). Upon a notification event, the is checked after the delay has been executed. true - this code will trigger the notification only if the value of is equal to 'some_value'.

Accessing form data from the notification

Wherever you have access to Liquid inside the notification, you can access data submitted in the form which triggered the notification using the variable. Its structure mirrors the associated form's property. When in doubt, you can always use it to visualize the structure. If you want to access properties not included in the variable, you should use a GraphQL query to fetch them. You can access the of the resource associated with the submitted form via .

Related Topics

Please visit the following topics to learn more about Notifications:

Have a suggestion for this page?

Didn't quite find what you are looking for or have feedback on how we can make the content better then we would love to hear from you. Please provide us feedback and we will get back to you shortly.