Fundamentals

Rollout executes automated workflows, transferring data between your app and others on behalf of users.

This page describes the core concepts that explain how Rollout works.

Defining roles#

When using Rollout there are four different stakeholders commonly referred to:

  • Rollout: The entity that connects your product to other SaaS products
  • Partner: This is you. You implement the Rollout solution within your product to deliver integrations to your end users
  • Users: Your users or customers that will integrate other products they use with yours
  • Third-Party Apps: External software applications that Users will integrate with the Partner’s app, e.g. Slack or Google Sheets.

What are Automations#

An Automation is an automated workflow which consists of two parts:

  1. The Trigger which starts the Automation. For example, when a form is submitted in your app.
  2. The Action, which is an operation performed inside another app. For example, sending a message to a channel in Slack.

What are Triggers#

Triggers are events that occur in an app and can start an Automation. They consist of 5 parts:

  1. The App, in which the trigger event will occur, e.g. Shopify.
  2. The Event, which triggers the Automation, e.g. when a new order is created.
  3. The User Account, which is the account in which the event occurs e.g. the Shopify store.
  4. Inputs, which filter the events being listened to, e.g. only trigger when a specific product is ordered.
  5. Outputs, which is data that describe the event, e.g. the product that was ordered, which customer ordered it and how much was paid.

What are Actions#

Actions are operations performed within an app. They consist of 5 parts:

  1. The App, in which the action will occur, e.g. Slack.
  2. The Operation, which which is performed within the app, e.g. sending a message.
  3. The User Account, which is the account in which the action occurs e.g. the Slack account to send a message from.
  4. Inputs, which is data to configure the action, e.g. the specific channel the message should be sent to and the message content.
  5. Outputs, which is data that describes any outcome of the event, e.g. whether the message was successfully sent or not.

You can also reference the Trigger Outputs in the Action Inputs. For example, if the Automation is "when a new order is created in Shopify, send a Slack message", then the Slack message content (the Action Input) will be able to reference the order detail (the Trigger Outputs) and send a message such as "New order: 50 Jellybeans were purchased by John Smith for $10.00 🔥"