API Reference

📘

Prequisites:

Step 1

Begin by clicking on “+ Create Campaign” either on the sidebar or the campaigns page on the dashboard.

Step 2

Choose "Streaks" from the campaign modal.


Step 3

Enter the essential details of your campaign. This includes:

  • Name: The title of your campaign.
  • Trigger: The action or event that will start your campaign. You can select an existing trigger or create a new one.
  • Audience: Specify which users will see this campaign.
  • Description (optional): A brief overview of what your campaign is about.


Step 4

Define the task you want your user to maintain a streak on, and specify the reward they will receive upon completion.

Streak Type: Choose whether the user should maintain a daily, weekly or monthly streak for the task you give them.

Now create a task by filling the following fields:

  • Task Name: Enter the name of your task.
  • Event to reward: Choose the event that the user needs to perform in order to complete the task
  • Frequency of event: How many time should the user perform an event to complete the task.
  • Task Reward: Enter the quantity and the reward that you want the user to get upon task completion.
  • Fallback event:This event will be triggered when the user is about to miss their streak.


Step 5

Finalize your campaign setup. You can choose to launch it immediately or schedule it to go live at a later date.