Automations

An Automation is an automated workflow that takes the form:

When a Trigger event occurs do an Action

Overview#

An Automation consists of 2 parts:

  1. Trigger
  2. Action

An Automation also specifies how to map data from the Trigger as inputs to the Action.

The app in which the Trigger or Action occurs can be either the partner app or a third-party app.

How to create Automations#

There are two ways to create Automations:

  • Have your users create them using a Rollout UI Component
    • optionally prefill data so that your users have certain parts of the automation filled by default
  • Via Rollout API

How users create Automations#

If you choose to embed a Rollout UI component like the <AutomationsManager />, your users will have the ability to create, update & delete Automations.

Automation Custom Data#

The customData property on Automation can be used to attach any arbitrary data for later use for things like filtering, grouping and keeping track of relations in your application.

customData can be set when creating (or updating) an Automation via API, or in the onBeforeAutomationCreate callback property of AutomationsManager or AutomationCreator.