Building Ongoing Campaign

Trigger the outbound bot to start its campaign using webhooks to send the contact data.

Available on the STARTER plan and above.

Pre-requisites:

Depending on the channel you want to broadcast on, you would need,

• Email API (Supported partner: TechAlpha)

• SMS API (Supported partner: Twilio)

• MMS API (Supported partner: TechAlpha)

• WhatsApp API (Supported partner: Meta, 360dialog, Twilio, GupShup, TechAlpha, Unifonic)

If you do not have an API, you can reach out to sales at [email protected].

Step 1: Create an outbound bot

1. Goto Bot builder

2. Choose "Build a bot" then select "Build an outbound bot"

3. Select "Ongoing" campaign as we want this broadcast to run when contacts are enrolled

Step 2: Configuring the webhook

Click on the 'Trigger' block and choose Webhook as the import source.

Your system should invoke our webhook with the required contact payload to trigger them into this broadcast.

To trigger this webhook, you will need:

• Webhook URL - Found on the trigger block

• Authorization token - Go to Settings > Account Settings > Developer

• Payload - The contacts data you want to send the broadcast to

// Payload example for a single contact
[
    {
    "name": "John Doe", 
    "phone": "18181818181",
    "email": "[email protected]"
    }
]

// Payload exmaple for bulk contacts
[
    {
    "name": "John Doe", 
    "phone": "18181818181", 
    "email": "[email protected]"
    },
    {
    "name": "James Doe", 
    "phone": "18282828282", 
    "email": "[email protected]"
    }
]

Max limit of contact records is 10,000 contacts in single request

Step 3: Map the response fields to variables

To store the contacts received from your webhooks, map the API response fields with the contact variables that you want to save it in.

This mapping is done to help you dynamically replace values in the messages of your campaigns.

For example, if you want to include a message like "Hello {name}, glad we could meet on {date}", you need to store the name and date field as variables in the contact mapping.

It is mandatory to have a phone/email field mapped, in order to be able to send a campaign to contacts.

Step 4: Create your campaign flow

Create your desired flow by adding blocks like Send SMS or Send WhatsApp and configure its fields on the right panel.

The configuration fields would differ based on the channel you use.

Step 5: Deploy to activate this campaign

Once your flow has been created, double-check all the messages for typos or any other mistakes and hit Deploy. A confirmation prompt will be shown to you for final approval before launching the campaign.

Now, when your systems invokes the webhook, the contacts will be enrolled into this outbound bot flow.

You can turn off your outbound bot, if you do not want to accept any new requests.

Viewing campaign reports

Once the bot is deployed, it may take a few minutes for the bot to finish sending all the messages to the recipients. This delay may vary based on the contact list and the API provider you have used.

Wait for a few mins and then visit Analytics > Outbound to see the reports.

Learn more