1. Actions
  2. Notifications

Actions

Notifications

Common Logic

  • All notifications have a send_to property
  • This tells the system where to send notifications
TIP

See contacts on how to create contacts and how to get their contactuuid

Setting up the send_to property

  • 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.

loading...

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
loading...

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
loading...

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

loading...

Parameters

type

required
string

  • type of contact data you inserting
  • for this case it is a single contactuuid

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
loading...

Parameters

type

required
string

  • type of contact data you inserting
  • for this case it 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

loading...

Parameters

type

required
string

  • type of contact data you inserting
  • for this case it is of type raw

value

required
string

  • Raw contact point formatted