Workflows
Workflows enable a user to set up an operation that modifies multiple entities (Offers, Publishers, or Advertisers) at the same time in Swaarm. For example, you can set up a workflow that checks if a publisher is beneath a certain conversion rate on every offer update, and sets a reduced click budget if the condition is matched. Workflows is similar to automation rules, but simplify the setup and control you have over the actions that are carried out.
Below we will cover Workflows for Offers, Advertisers, and Publishers and include some use cases.
✏️ Quick Note
Workflows will not take action on Archived offers.
How to Create a Workflow for Offers
Go to the menu and click on Automation > Workflows
You can view and manage all your workflows for offers here
Click + Create Workflow
You have 4 major steps to a workflow to setup which will be covered in the following steps
General Settings: Provide a name and description of the workflow
Name: Provide a human-friendly name to identify the workflow
Description: Some information to describe what the workflow is doing
We recommend being detailed here so you understand fully what this workflow is trying to accomplish.
Check off the Active button if you want the workflow to be activated once saved, you can also set this active later.
Filters: Choose which offers should be modified. If no filters are added, all offers will be considered for the below-configured actions.
Select a field and then an operation and then a value to decide which offers should be modified
Helpful Note: Timeframe is attached by default at the end of the stats filters (e.g., clicks, conversions, revenue, etc.). It is the time period that would look back at the last X amount of hours you input here. The image above it is looking back at the last 10 hours if there were more than 10000 clicks on Sample Offer 2.
Actions: Choose which actions should be applied to the above-filtered offers
Configure Status: Set the offer status to either Approved, Pending, or Paused
Configure Offer: Set offer details
Set if these values shown above are on or off.
Configure Targeting: Set the advanced targeting on the offer
You can set up advanced targeting for the offer and override existing targeting.
Configure Budget: Add or update offer budgets
The 'Override Existing Budgets' button allows you to set a new budget on top of any budget that was already in place.
For example: If your offer had no budget in place for Hourly Click Budget then you do not need to check off Override Existing Budgets, but if there was a budget in place you would need to override this budget by checking off this button.
Configure Tags: Add or remove offer tags
💡Note: For offer tags, the users who have permission for tags creation can create and add new custom tags to the offer. Other user roles will have access to only existing tags in the platform i.e. they can add/ remove tags from the list of existing tags.
Configure Publishers: Select publishers and configure publisher-level budgets, payouts, and access status
Select which publishers should be configured by this workflow
Select by Publisher ID or Name and/or by Tags
Include specific publishers for this workflow
Exclude specific publishers from this workflow
Use Approved/Pending/Blocked Publishers based on the publisher status of the targeted offers
💡Note: If you want to exclude some publishers, then before that, either add publishers manually or select from approved/ pending/ blocked publishers.
Budgets: Configure publisher budgets similar to the 'Configure Budgets' step above
Payouts: Configure the payouts and margin of the publisher and you can override existing payouts if there is already a payout in place before this workflow by checking the box
Access Status: Configure the publisher's access status to the offer, and you can override any current access status that was in place before the workflow by checking the box
Configure Publisher Groups: Add a new publisher group
Create a publisher group for the offers selected in the workflow, see more about publisher groups here
💡Note: From workflows, the publisher group can't be overwritten, it will create a new publisher group.
Schedule: Choose on which schedule the actions should run
Manual: The workflow is executed immediately after the rule is saved
Helpful Note: If we 'edit' the existing workflow where the 'Manual' schedule is selected, then the workflow will be executed again when we Save it, this can be avoided by closing the dialogue using the 'x' icon on the top right corner or the close button at the bottom.On Schedule: This allows you to schedule the workflow every day, week, month, and year at a specific time.
Note: If you have a timeframe filter set in place to look back the last 10 hours and you select on schedule every day at 9 am, then this will look back the last 10 hours from 9 am every day.
On Offer Change: The workflow is executed whenever an offer is manually or programmatically updated
This could be an update via API or when a user edits the offer manually and clicks save
Last Step: Delete, Preview, or Save
Delete the workflow
Preview your workflow and see what entity will be affected and what actions executed
Save the workflow
How to Create a Workflow for Advertisers
Go to the menu and click on Automation > Workflows
You can view and manage all your workflows for advertisers here
Click + Create Workflow
You have 4 major steps to a workflow to setup which will be covered in the following steps
General Settings: Provide a name and description to identify the workflow later
Name: Provide a human-friendly name to identify the workflow
Description: Some information to describe what the workflow is doing
We recommend being detailed here so you understand fully what this workflow is trying to accomplish.
Check off the Active button if you want the workflow to be activated once saved, you can also set this active later
Filters: Choose which advertisers should be modified. If no filters are added, all advertisers will be considered for the below-configured actions.
Actions: Choose which actions should be applied to the above-filtered advertisers
Configure Status: Set advertiser status
Set the advertiser status to active, blocked, delete, paused, pending, or rejected
Configure Tags: Add or remove advertiser tags
Note: For advertiser tags, the users who have permission for tags creation can create and add new custom tags to the advertiser. Other user roles will have access to only existing tags in the platform i.e. they can add/ remove tags from the list of existing tags.
Schedule: Choose on which schedule the actions should run
Manual: The workflow is executed immediately after the rule is saved
Helpful Note: If we 'edit' the existing workflow where the 'Manual' schedule is selected, then the workflow will be executed again when we Save it, this can be avoided by closing the dialogue using the 'x' icon on the top right corner or the close button at the bottom.On Schedule: This allows you to schedule the workflow every day, week, month, and year at a specific time.
Note: If you have a timeframe filter set in place to look back the last 10 hours and you select on schedule every day at 9 am, then this will look back the last 10 hours from 9 am every day.
On Advertiser Change: The workflow is executed whenever an advertiser is manually or programmatically updated
Last Step: Delete, Preview, or Save
Delete the workflow
Preview your workflow and see what entity will be affected and what actions executed
Save the workflow
How to Create a Workflow for Publishers
Go to the menu and click on Automation > Workflows
You can view and manage all your workflows for publishers here
Click + Create Workflow
You have 4 major steps to a workflow to setup which will be covered in the following steps
General Settings: Provide a name and description to identify the workflow later
Name: Provide a human-friendly name to identify the workflow
Description: Some information to describe what the workflow is doing
We recommend being detailed here so you understand fully what this workflow is trying to accomplish.
Check off the Active button if you want the workflow to be activated once saved, you can also set this active later
Filters: Choose which publishers should be modified. If no filters are added, all publishers will be considered for the below-configured actions.
Select a field and then an operation and then a value to decide which publishers should be modified
Helpful Note: Timeframe is a filter you can choose that would look back at the last X amount of hours/days your input here. The image above it is looking back at the last 7 days if there were less than a 1% conversion rate on active publishers.
Actions: Choose which actions should be applied to the above-filtered publishers
Configure Status: Set publisher status
Set the advertiser status to active, blocked, deleted, pending, or rejected
Configure Access Status: Set offer access status
Configure Tags: Add or remove publisher tags
Note: For publisher tags, the users who have permission for tags creation can create and add new custom tags to the publisher. Other user roles will have access to only existing tags in the platform i.e. they can add/ remove tags from the list of existing tags.
Schedule: Choose on which schedule the actions should run
Manual: The workflow is executed immediately after the rule is saved
Helpful Note: If we 'edit' the existing workflow where the 'Manual' schedule is selected, then the workflow will be executed again when we Save it, this can be avoided by closing the dialogue using the 'x' icon on the top right corner or the close button at the bottom.On Schedule: This allows you to schedule the workflow every day, week, month, and year at a specific time.
Note: If you have a timeframe filter set in place to look back the last 10 hours and you select on schedule every day at 9 am, then this will look back the last 10 hours from 9 am every day.
On Advertiser Change: The workflow is executed whenever a publisher is manually or programmatically updated
Last Step: Delete, Preview, or Save
Delete the workflow
Preview your workflow and see what entity will be affected and what actions executed
Save the workflow
Watch a Video Guide on Workflows