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.

1. Setup providers​

Configure the credentials of your messaging providers such as Sendgrid, Twilio by logging in to Engagespot console, navigating to Channels.

👉 To make it easier for you, we have already enabled a default provider for email and sms.

2. Install In-App Inbox​

If you like to use the In-App Inbox, follow this guide. You can do this later if required.

3. Create a workflow​

Every notification in Engagespot is a workflow. Read this guide to create a workflow.

👉 To make it easier for you, we have already created a default workflow for you.

4. Trigger the workflow​

Trigger the workflow from your app's backend using our client library, or 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.