Documentation

Creating a campaign - v2.0

Suggest Edits

Pre-requisites

To create a Campaign, you will first need to have a few things in place:

  1. A provider integration in Fyno's platform
  2. A notification template (it may be any channel)
  3. A Notification Event
  4. A CSV file with the user base to whom you would be triggering the campaign.

Once we have these in place, we are all set to go with campaigns!

Creating a Campaign

To create a campaign,

  1. Login to your Fyno account and find Campaigns from the left navigation bar under 'Advanced' section.

  2. On the landing page of Campaigns, click on the 'New Campaign' CTA at the top right corner. It will open a popup as shown below.

  3. Enter a name for your Campaign and select the notification event you want to fire using this campaign from the dropdown.

  4. Once you have selected the event, you will see the channels linked to that event and also you will see a sample file structure which you need to upload (as shown below). For ex - The selected notification event has only SMS channel, thats why you see only SMS channel in the sample file structure.

  5. You can also download the sample CSV file by click 'CSV for selected notification event' .

  6. Once you have your CSV file ready, click 'Upload CSV file' or Drag and drop the CSV from your device.

  7. Once the file is uploaded, you will see a few important details:

    1. Number of records processed
    2. Number of records ready to be imported
    3. Number of records that are not valid (as per the checks in place). This could happen if there are any records without any destination and distinct Id etc.
    4. Number of duplicate records that were found.

📘

If you are using Distinct IDs, ensure that this data matches the pre-existing distinct Ids in User Profiles on Fyno.

  1. Click 'Create Campaign' to import the valid records from CSV.

Configuring Campaign

You will see the below screen

  1. Notification Event: The notification event is preselected based on the value selected.

  2. Map destinations & Placeholders: In this step, you will need to configure the details needed for the event to be successfully triggered. This includes the mapping of the Channels and Placeholders. You can select each item's corresponding data field from the uploaded CSV file by clicking on the drop-down and selecting one. In case you do not want to trigger a notification to a specific channel, you can remove it by deleting that row from this section.

  3. Preview : Preview allows you to visualize how the data from a CSV upload appears within the template, ensuring the uploaded data aligns with your expectations. You will see the preview as shown below. You can click '<' and '>' to see a preview based on the first 10 records from the uploaded CSV file.

How to enable receiving Delivery reports from Fyno

To enable receiving delivery reports from Fyno, select the checkbox 'Receive delivery report from Fyno to my allowlisted endpoint(s)'. This enables the callbacks for the channels and essentially sends back the delivery updates about each notification triggered. On checking this box, 3 additional placeholder details will need to be configured.

  1. Custom ID - This is mandatory field. This is the ID you provided in the callback.custom_id field while triggering the notification.
  2. Custom1 - This is optional field
  3. Custom2 - This is optional field

By default you will receive these 3 values in callback: custom_id , msg_id , status
custom_id - Is the ID you provided in the callback.custom_id field while triggering the notification.
msg_id- is the message ID within Fyno.
status - Is the status of the message:

  1. More values can be added in the callback. For a list of additional available values, please see:
    https://docs.fyno.io/docs/allowlist-url#callback-response
  2. Reset: Resets all the configurations for the Map Channels and Placeholders section.

How to throttle a campaign

Throttle is optional but we recommend using it. Throttling allows you to control the rate at which notifications (Emails/SMS/WhatsApp/Push/WebPush) are sent to users.

  1. By Time - You can specify a duration for which the campaign should run. For example, if you want to execute the campaign for an hour, you can do that by entering 60 minutes.

  2. By Batch - In this option, you can throttle the number of records the campaign should send for a specific duration. For example you want to send a execute a batch of 1000 records in the csv file every minute, then you can enter 1000 records and 1 minute

How to test a Campaign

Just before you send out a campaign to all your customers, running a test is always a good idea, since you will be able to preview the look and feel of your notifications before they go out.

To do this, once you have set up your campaign, simply:

  1. Scroll to the top of the campaign configuration page to find the Run Test button and click on it.
  2. A new pop-up requesting the below information to run the test will come up:
    1. Send Using (Channel Details): Map the channels that are there in the notification event to run the test on.
    2. Map Placeholders: Map the placeholders that are there in the template of the corresponding Notification event to successfully simulate the notification.
  3. Once ready, click on run test to get the notification delivered to the corresponding test recipients.

Save as Draft

Once an event is configured with the details of the Notification Event, mapped Channels and Placeholders and scheduled time, this can now be saved to use or edit at a later time.

Simply click on the Save at any point in time of configuring the campaign and this will be saved for later use!

How to Fire or Schedule a campaign

Once you have done with all the configuration, you can click Schedule/Fire CTA. You can fire it in 2 ways.

  1. Now - If you select Now and click 'Fire', the campaign will be fired immediately and your users will start getting notifications.

  2. Later - If you select Later, you will be asked to select a date and time when you want to fire the campaign.

📘

You can select a date upto 30 days from the time of selecting the schedule.

Once you have successfully fired a campaign, you can see the progress as shown below.

How to stop a Campaign

If you want to pause a campaign after its fired, you can click the Stop Campaign and status of the campaign will show as Stopped.

Updated 8 days ago