Boolean ConditionControl the flow of execution within your workflow using different paths in an if/else manner
As mentioned in How to use Tray.io The 'Boolean Condition' connector allows you to ask crucial questions before deciding what action to take in your workflow, such as:
- Did the new customer opt-in to marketing? If so tag them as 'opt-in' in our CRM
- Does this company have annual revenue above a certain amount? If so add them as a prospect and collect all the data we have on them
- Does this person have missing payment information? If so pull it from our database and update
- Is it more than 3 months since we last contacted this person? If so then change their status in Salesforce/Marketo and send a reminder to contact them via Slack
- Is it less than a month before this person's subscription runs out? If so then send them an email reminder, update their status in Salesforce and alert their account manager
- Is this person's order status 'unfulfilled'? If so add it to a priority processing queue
How it works
When using the boolean condition we set up a series of one or more conditions. If those conditions are met then the steps on the “TRUE” branch will run. If they are not met then the steps on the “FALSE” branch will run instead.
Conditions are made up of two values and a comparison type. We compare these two values to determine whether a condition is met.
The Boolean connector has an option call 'Strictness'. This determines whether ALL of the conditions have to be satisfied or ANY of the conditions need to be satisfied.
If you select Satisfy ALL conditions then every one of the conditions needs to be satisfied in order for the workflow to follow the TRUE path. If you select Satisfy ANY conditions then only one of the conditions needs to be satisfied for the workflow to follow the TRUE path.
Values can be any of the usual Tray types. You can compare, strings, numbers, booleans, objects and arrays. Also, you can set either of these values to be null. Usually both values will be of the same type.
Simple boolean example
Here's how to set up a workflow that checks to see if a Slack channel exists or not, and then send a different message based on the result.
Create a new workflow, using a manual trigger.
Add a Slack connector, and choose the "Channel Exists?" operation. Type a channel name that does exist for now:
- Add a boolean condition connector to the workflow, and use the
$.steps.slack-1.existsjsonpath to pass the "exists" property from Slack to the 1st Value property in the boolean condition:
We know to use the
$.steps.slack-1.exists jsonpath as this is what is picked up by the data 'connector snake':
- Change the type of the "2nd Value" property to "boolean"
Ensure that the checkbox is ticked. (This means "true").
Note: we've changed the type of the "2nd Value" to a "boolean" type because the type of the "exists" property coming from Slack is also a boolean.
In other circumstances you might leave the type as 'string' (i.e. plain text) and check for something simple such as account status is equal to 'open' or marketing prefence is equal to 'opt-in'.
- Add a Slack connector to the "TRUE" branch, to send you a message indicating that the channel exists in Slack.
Click 'Run workflow now' - you should see a message appearing in Slack!
Add another Slack connector to the "FALSE" branch, to send you a message indicating the channel doesn't exist:
- Change the channel name in the first Slack step you added (the one to check if the channel exists) to a channel that doesn't exist.
- Run the workflow again - you should see the message from the FALSE branch this time!
Checking log output
It is always useful to inspect the log output (by clicking on 'Debug') of connectors to see what data you are checking for when using the Boolean connector.
In the above example we can check the output of the first Slack step which uses the Channel Exists? operation:
This confirms that we should use the
$.steps.slack-1.exists jsonpath as we did.
Further notes on general usage
Comparison types can be different depending on what you're comparing. Every comparison is either TRUE or FALSE.
Equality (Equal to / Not equal to)
Any type can be compared like this. It simply checks whether the values are the same.
- “Tray is awesome” Equal to “Tray is awesome”
- 5 Equal to 5
- “Up” Not Equal to “Down”
- True Equal to False
- 100 Equal to 2
- null Equal to “String”
Numerical Comparison (Smaller than / Smaller or equal than / Greater than / Greater or equal than)
These comparisons are used to compare numbers.
- 5 Greater than 2
- 5 Greater or equal than 5
- 0 Smaller than 1
- 10 Smaller than 5
- 1 Greater or equal to 2
- 2 Greater than 2
Lists (In list/Not in list)
These comparison types are for determining whether a given value is in a list. For these comparison types the second of the two values needs to be an array. It will return TRUE if the value exists in the list and FALSE if it does not. If the second value is not an array then this will error.
The Property Exists operation
The other operation available within the Boolean Condition connector is Property Exists. This takes a JSON path and returns true if the given path exists and it has a value. This is useful for checking that incoming data is valid before processing it.
You can see an example of it on our page on Conditional Logic
You can see more examples of use cases for the Boolean connector at the above page on Conditional Logic