AutomationCreator

Description#

This component renders a form with everything needed to set up a new automation.

Import#

import { AutomationCreator } from "@rollouthq/connect-react";

Usage#

Here's a basic usage example:

<AutomationCreator
  onAutomationCreated={() => navigate("/automations")}
  onBeforeAutomationCreate={({ automationData }) => {
    return {
      automationData: {
        ...automationData,
        customData: {
          arbitraryProp: "abc123",
        },
      },
    };
  }}
/>

Props#

prop	type	required	Description
`blueprintKey`	`string`	`false`	In case you want to create a Blueprint Automation, pass in the unique key of blueprint.
`onAutomationCreated`	`({ automation }) => void`	`true`	A callback to call after user successfully sets up an automation. The callback can take the newly created Automation object as a parameter. You can use this to navigate away.
`onBeforeAutomationCreate`	`({ automationData }) => (boolean \| { automationData) }`	`false`	A callback to call before request to set up an automation is sent. You can use this to prevent the automation from being created (by returning `false`) or modify the `automationData` (an Automation object) to attach `customData` or otherwise tweak the automation data. Can be `async`.
`onCancel`	`() => void`	`false`	When provided, a Cancel button will be rendered next to the Save button with this callback hooked to it.
`prefilled`	`object`	`false`	Data that can be prefilled for the trigger. See the section on creating automations.
`getDefaultActionInputParams`	`function`	`false`	See Dynamically Prefilling Actions.
`getDefaultTriggerInputParams`	`function`	`false`	See Dynamically Prefilling Triggers.
`renderFields`	`object`	`false`	See Customizing Automation Form.
`allowedActions`	`object \| function`	`false`	See Limiting Allowed Apps.
`allowedTriggers`	`object \| function`	`false`	See Limiting Allowed Apps.
`cancelButtonText`	`string`	`false`	Allows customizing the text value of the 'Cancel' button.
`enableButtonText`	`string`	`false`	Allows customizing the text value of the 'Save' button.
`variableMenuActivator`	`string`	`false`	Customizes the text that triggers variable list in text editor.