Augment step can be used to add additional resources to flow.
Why use Augment Step?
Resources are heavily used in OnVoard Flow.
- Flow Filter use resources to evaluate logic.
- Flow Branch use resources to evaluate logic.
- Resources data are passed when you send email (via Flow Action).
- Variables will be generated from resources.
Sometimes, the default attached resources from trigger may not provide sufficient data to perform required task. In this case, you can use augment step to add additional resources on top of existing resources.
How it Works
Let's use an example to illustrate how augment step works.
In this flow, we are using Import Data action to sync new customers from our Shopify store. By default, the trigger provides us with Shopify Customer
resource. There's a possibility that the customer already exists in our database, since a person may subscribe to our list before making a purchase.
In this case, let's say we want to check if the new customer is non-sendable (since the customer could've bounced or unsubscribed), and update their status on Shopify accordingly. To accomplish that, we need to augment Contact resource in order to inspect sendable state.
Diving into augment step (Step 3), we are using {{ shopify.customer.email }}
value to search for records with matching email from Contact resource.
On Step 4, we are using filter to evaluate if contact is sendable. If the contact is not sendable, we will proceed to the last step and update their status on Shopify to unsubscribed.
Augment Order
One point to note is that augmented resource will only be available in steps after augment. This means that if you augment Contact resource in step 2, it will only be available for step 3 onwards.