Actions

Notifications

# Overview

Notifications are a way to send messages on various platforms to contacts or contact lists or raw contact points.
Each notification platform has certain requirements and capabilities.

Understanding notifications means understanding sending outgoing notifications and also routing incoming notifications.

# Notification Platforms

There are many implementations of notification platforms in Stubber, see the details for each platform in the platform specific documentation.
These are some of the notification platforms available in Stubber:

• Slack
• Email
• Mobile App
• WhatsApp
• Telegram
• SMS
• Facebook Messenger
• Webchat

# Outgoing Notifications

• All notifications have a send_to property
• This tells the each notification platform where to send notifications

# Sending to multiple destinations

• You can have any amount of objects in the send_to object
• These objects can have any name as seen below
• The system will send the notification to each send_to destination

In the below example the system will send notifications to 3 locations customer, sales, myself.

# Sending to a notification platform

• To send to a specific notification platform you need to specify a platform as an object
• Below is an example of sending to the mobile-app platform

# Sending to multiple notification platforms

• You may want to send notifications to multiple platforms
• This will result in the contact receiving notifications on slack and their mobile device

# Sending notifications to a contact

• Notification platforms uses contact points to send notifications

• If a contact has no contact point they wont be able to receive notifications

• the only exception to this is the mobile-app platform. Mobile app is bound to a user , notifying a contact associated with that user will result in a notification

# Parameters

# type

required

string

• the type contactuuid indicates that the value is a contact uuid

# value

required

string

• A single contactuuid that the notifications will be sent to

# Sending notifications to a contact list

• You may create contact groupings in stub if you want to send to multiple people at once
• This example assumes you have already created a contact group called custom_contact_group

# Parameters

# type

required

string

• the type listname indicates that the value is a contact list

# value

required

string

• Name of the contact list you wish to send to

# Sending notifications to a raw contact point

• Raw types are specified in the send to object itself

• typically you dont want to use these when sending multiple notifications

• Raw values represent the string format of a contact point

• For slack the raw value would be WorkspaceName:ChannelID

• Raw contact points are unique to each platform due to each platform requiring different parameters

# Parameters

# type

required

string

• the type raw indicates that the value is a raw contact point

# value

required

string

• Raw contact point formatted

# Incoming Notifications

Incoming notifications are routed to the correct stub based on the notification platform and the contact point used to send the notification.
There are two primary ways of routing incoming notifications within Stubber :

• Stubsession Routing, easy to use and understand
• Heimdall, for more advanced functionality

The primary method of routing incoming notifications is Stubsession Routing.

Essentially when a notification is received, Stubber will try to find a stub that the notification should be routed to. Then the Feedback Action for the respective notification platform will be triggered on the stub.