Advanced FeaturesCampaigns

Creating a campaign

Pre-requisites

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

  • A provider integration in Fyno’s platform
  • A notification template (it may be any channel)
  • A Notification Event
  • A CSV file or Google sheet or Public URL or a Cohort 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,

1Login to your Fyno account and find Campaigns from the left navigation bar under ‘Advanced’ section.
2On the landing page of Campaigns, click on the ‘New Campaign’ CTA at the top right corner. It will open a popup as shown below.
3Enter a name for your Campaign and select the notification event you want to fire using this campaign from the dropdown.
4Once 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 and WhatsApp channel, thats why you see only SMS and WhatsApp channel in the sample file structure.
5

You can create a campaign in any of the following ways:

  1. CSV upload
  2. Google sheet
  3. Public URL
  4. Cohort

Creating a campaign using CSV upload

If you want to create a campaign using csv upload,

1You can also download the sample CSV file by click ‘CSV for selected notification event’ .
2Once you have your CSV file ready, click ‘Upload CSV file’ or Drag and drop the CSV from your device.
3

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.
  5. If there are any duplicates present in the csv uploaded and if you still want to include the duplicate data, then select the checkbox ‘Include duplicates in campaign’.
4Click ‘Create Campaign’ to import the valid records from CSV.
If you are using Distinct IDs, ensure that this data matches the pre-existing distinct Ids in User Profiles on Fyno.
If you want to use JSON data, upload it in a pre-defined field ‘csv-json-payload’, and map this column in the campaign to send a placeholder to the event as a JSON object

Creating a campaign using Google Sheet

If you want to create a campaign using Google sheet,

1Select Google sheet. You will see the list of requirements. Please make sure all the requirements are satisfied.
2Provide a Google sheet link in the ‘Link to Google sheet’ field and click ‘Validate Records’.
3You will see the validation as shown.
4Once all the records are ready to be imported, click ‘Create Campaign’.

Creating a campaign using Public URL

If you want to create a campaign using Public URL,

1Select Public URL. You will see the list of requirements. Please make sure all the requirements are satisfied.
2Provide a Public URL link to the CSV file in the ‘Link to CSV’ field and click ‘Validate Records’.
3You will see the validation as shown.
4Once all the records are ready to be imported, click ‘Create Campaign’.

Creating a campaign using Cohort

If you want to create a campaign using Cohort,

1Select Cohort. You will see the list of requirements. Please make sure all the requirements are satisfied.
2Select a cohort created in the User profile section. To learn more about how to create a cohort, refer this doc. Click ‘Validate Cohort’.
3You will see the validation as shown.
4Once all the records are ready to be imported, click ‘Create Campaign’.
When ‘Include duplicates in campaign’ is enabled, any duplicate records in your uploaded file will be processed. This means your users may receive the same communication multiple times. To prevent spam, consider leaving this option disabled.

Configuring Campaign

Once you have uploaded a CSV or linked a CSV using Google sheet or Public url or cohort, 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.

Ensure all placeholders are properly mapped to your columns. For WhatsApp specifically, notifications will fail to deliver if any placeholder remains unmapped.

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.

Allowlisted Endpoints
string
  • Specify one or more allowlisted URL names (upto 3) where you want to receive delivery reports.
  • If no URL name(s) are specified here, the system will use your default URL (if one exists).
  • If no URL name(s) are specified here AND no default URL is set, delivery reports cannot be sent.
  • Example: ["DynamicWebhookSite", "Mixpanel"]
  • Example: DynamicWebhookSite
Custom ID
stringRequired
  • Unique identifier of your notification
  • Length: 200 characters if string
  • Length: 20 digits if numeric
Custom Value 1
string
  • Additional information to tag your notification
  • Length: 50 characters
  • Example: campaign-name
Custom Value 2
string
  • Additional information to tag your notification
  • Length: 50 characters
  • Example: category

More values can be added in the callback. For a list of additional available values, please see: Callback Response

Click Reset to reset 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.

  1. 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:

1Scroll 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.
3Once 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.

Please note that ‘Stop Campaign’ will be enabled only for CSV with more than 1000 records.

How to receive a campaign completion report over workflow?

1Create a workflow with the name FynoCampaignCompletionStatus.
2The following payload is accessible in the workflow
Trigger workflow with Campaign Status
1{
2  "type": "campaign-completion-status",
3  "status": "success|fail|subfail",
4  "upload_id": "UPXXXXXXXX",
5  "count": 1XXXX,
6  "campaign_name": "Your Campaign Name",
7  "process_count": 1XXXX
8}
4Configure a Call API widget to post campaign details to your Allowlist endpoint.

Payload data

The following parameters are sent as payload to trigger the workflow FynoCampaignCompletionStatus

  • Campaign Status

    1. success : Campaign Successfully Fired.
    2. fail : Campaign stops during execution due to an unknown error, campaign may execute partially.
    3. subfail : Campaign executes successfully but All req may not submitted to the provider due to invalid details like destination,distinct_id, integration

  • Upload_id : This is available only if you are using Campaign API to create and trigger a campaign.

  • Count : No of valid records uploaded through campaign.

  • Process Count : No of records successfully processed.

  • Campaign name : The name of the campaign for which the status is sent.