Application Logic for Notifications with Courier Automations

We’re excited to announce a powerful new feature for the Courier platform: Courier Automations.

Courier Automations is a toolset that includes both an API and a visual builder that allows anyone to easily configure logic for notification workflows. Need to send a reminder to class attendees 10 minutes before the class starts? Need to page an on-call engineer on multiple channels until they respond? These use cases and more can be achieved quickly and easily with Automations.

Why we built Automations

As developers, notifications are the primary way that the applications we build communicate with our end-users and the use cases vary widely. Some use cases are very straightforward and simply require that a single message goes to a single user once. Many notifications however require more sophisticated orchestration in order to deliver the desired user experience. Most developers today end up building a separate service to manage this logic. This results in additional infrastructure and development overhead and often in a less than ideal end-user experience.

We built Automations so that developers can deliver the ideal notification experience without needing to build and maintain yet another service.

What are product and engineering teams doing with Courier Automations today?

While today marks the official release of Automations, many of our customers are already using Automation to power key parts of their product experience.

The engineering team at LaunchDarkly, a feature management platform, uses Automations to define the logic for notifications associated with approvals for their customers' feature releases. Any time approval is requested or granted, an Automation is triggered to ensure all the relevant stakeholders are alerted. You can read more about their use case here.

Officevibe, which is an employee experience platform, regularly sends out Slack notifications on behalf of their customers asking employees to complete a brief survey. Their engineering team utilizes the Automations API to create lists of users for whom the Slack survey could not be delivered and send them an email survey instead.

For Yoga International, an online Yoga platform, it's essential that they deliver a seamless experience to their customers from the time they register for a live class through to the start of class. Their engineering team utilizes the Automations API to send timely reminders to class attendees for each live class that happens on their platform.

“Meetings Reminder”

Let's build a meeting reminder that sends an email reminder 10 minutes before the meeting and a link to the meeting notes two hours after the meeting.

Design the Messages:

1. Log into Courier and navigate to the Notifications Designer

2. Design an email reminder that will be sent 10 minutes before the meeting with the Gmail provider (or any email provider of your choice)

   
   

   

3. Access the template ID in the settings of that notification and save it for future reference

4. Design an SMS reminder that will be sent two hours after the meeting with the Twilio provider (or any email provider of your choice)

   
   

   

5. Access the template ID in the settings of that notification and save it for future reference

How To Create an Automation Using the API (Node.js Example)

1. Within your Node.js app, install node-fetch npm install node-fetch

2. Navigate to the Automations API Reference and copy the starter code

3. Add an automations object with an array of objects called steps

   
   

"automation": {
      "steps": [
        {
          "action": "send",
          "template": "template_id",
        }
      ]
    },

Automations API Reference

Automations Docs

4. For this example, we will need three steps: send, delay, and another send. The first send step will send the 10-minute reminder. The delay step will wait for two hours after the meeting. The third step will send an SMS with a link to the meeting notes.

"automation": {
    "steps": [
      {
        "action": "send",
        "template": "template_id_1"
      },
      {
        "action": "delay",
        "duration": "130 minutes"
      },
      {
        "action": "send",
        "template": "template_id_2"
      }
    ]
  },

5. Update template_id_1 with the notification template from Step 3 of “Design the Message” and update template_id_2 with the notification template from Step 5 of “Design the Message”

6. Update the brand and recipient attributes with your preferred brand and recipient IDs

7. If your steps reference any Notification Templates, update the ID template attribute

8. Run your code to trigger the Automation

   
   

// Dependencies to install:
// $ npm install node-fetch --save

const fetch = require('node-fetch');

const options = {
  method: 'POST',
  headers: {
    Accept: 'application/json',
    'Content-Type': 'application/json',
    Authorization: 'Bearer replace-token'
  },
  body: JSON.stringify({
    "automation": {
      "steps": [
        {
          "action": "send",
          "template": "template_id_1"
        },
        {
          "action": "delay",
          "duration": "130 minutes"
        },
        {
          "action": "send",
          "template": "template_id_2"
        }
      ]
    },
    "brand": "W50NC77P524K14M5300PGPEK4JMJ",
    "template": "EXAMPLE_NOTIFICATION",
    "recipient": "8ec8c99a-c5f7-455b-9f60-8222b8a27056",
    "data": {
      "name": "Jane Doe",
      "age": 27
    },
    "profile": {
      "phone_number": "2025550125",
      "email": "[email protected]"
    }
  })
};

fetch('https://api.courier.com/automations/invoke', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

9. Check the Datalog for delivery status and error messages

How To Create An Automation Using the Studio

This example demonstrates integrating an API V2 notification send call (Step 5 of "Design the Message").

1. Navigate to the Automations page

2. Create an Automation Template from scratch

   
   

   

3. Add a send step and select the “10-minute reminder” for the Notification

   
   

   

   
   

4. Add a delay step and update the length to 130 minutes

5. Switch over to code mode (top right, under the the “Publish Changes” button) and add an API V2 notification send call for the SMS with a link to the meeting notes

   
   

{
      "action": "send",
      "message": {
        "to": {
      		"email": "[email protected]"
    	},
    	"content": {
    		"title": "Meeting Notes",
    		"body": "Link to meeting notes: ..."
    	}
      }
    }

This step can be done within the designer by following Step 3

6. Select a trigger for the Automation (if no trigger is selected, the Automation can be triggered manually with a curl command)

7. Publish changes to save your Automation

8. Create a Test Event to test your Automation

   
   

{
  "data": {},
  "profile": {
  	"email": "[email protected]",
	“name”: “Your Name”
  }
}

9. Invoke your Automation in the Designer or copy the starter code and run it in a terminal

Getting Started

Sign up for a free Courier account to get started with Automation. Courier’s Free Tier includes Automations and up to 10,000 notifications per month.

Originally published here.