Skip to main content
Version: 1.5.x
Getting Started

Quick Setup

We'll learn how to send notifications to your users in few simple steps.

Setup providers​

Providers are third party services like Twilio, Sendgrid etc that are required for delivering messages as you you might have read in the basic concepts chapter. Login to Engagespot console, navigate to Channels, and enable required providers.

Install In-App Inbox component​

If you don't want to enable the In-App channel, you can skip this step.

If you enable the In-App channel, you should setup the inbox component in your front-end app. Follow this guide.

Create a workflow​

The best way to send notifications via Engagespot is by creating workflows. Workflows allow you to define a series of steps or actions that will be executed automatically based on specific triggers or conditions.

To learn how to create workflows, read this guide.

Trigger the workflow​

After creating the workflow, you can trigger it from your app's backend using a client library of your choice such as Node.js, PHP, or even our REST API. You can also trigger workflows using plugins available for no-code tools like Bubble.io

const { EngagespotClient } = require('@engagespot/node');

const client = EngagespotClient({
  apiKey: 'YOUR_ENGAGESPOT_API_KEY',
  apiSecret: 'YOUR_ENGAGESPOT_API_SECRET',
  dataRegion: 'us',
});

client.send({
  notification: {
    workflow: {
      identifier: 'welcomeMessage',
    },
  },
  data: {
    key: 'value',
  },
  sendTo: {
    recipients: [
      {
        identifier: 'johndoe001',
        email: 'johndoe001@gmail.com',
      },
    ],
  },
});

Advanced setup​

Hurray! 🎉. You just learned how to send messages to your users! Now you can learn more advanced concepts in the upcoming lessons.