Platform Automations: triggers, actions, and pipeline steps reference
Use this reference to understand the fields used when you create or edit a platform automation, and when you configure its pipeline steps. It also explains which fields are required and when some fields cannot be changed.
How do I set up a platform automation?
Start by creating the automation, giving it a clear name, and selecting the trigger type. Some trigger types also need a precondition, such as groups, teams, or a delay after hire date. Then save the automation and add pipeline steps if the selected trigger supports them.
After the automation is created, the Trigger type cannot be changed. If you need a different trigger, create a new automation instead.
What fields are available when I create or edit an automation?
Automation Name: Enter a descriptive name for the automation. This field is required.
Trigger Type: Select the event that starts the automation. You choose this when you create it, and it cannot be changed later. The available trigger types are grouped by category.
Enabled: Turn the automation on or off. If it is disabled, it will not run.
Which fields depend on the trigger type?
Precondition: Use this when the trigger depends on assignment to groups or teams. The exact field shown changes with the trigger type.
When assigned to any of the Group(s): Select the groups that should start the automation when a user is assigned to one of them.
When assigned to Team(s): Select the teams that should start the automation when a user is assigned to one of them.
Delay (in days): Enter how many days after the user hire date the onboarding form should be sent. This field is required for the onboarding form trigger, and it must be 0 or more.
Select Onboarding Form: Choose the onboarding form to send. This is required for the onboarding form trigger.
What do the pipeline step fields mean?
After you create the automation, add steps under Pipeline Steps. Each step has a Step Type and a configuration that depends on that type.
Step Type: Choose the action the automation should perform. Available step types include Delay, Send Email, Push Notification, Webhook, Condition, Assign Form, Add to Groups, Remove from Groups, and Assign Career.
Duration: Used for Delay steps. Enter a value of at least 1 and choose a unit.
Unit: Used with Duration. Choose Seconds, Minutes, Hours, or Days.
Subject: Used for Send Email steps. This field is required.
Body: Used for Send Email steps. This field is required.
Title: Used for Push Notification steps. This field is required.
Notification Body: Used for Push Notification steps.
URL: Used for Webhook steps. Enter the endpoint to call.
HTTP Method: Used for Webhook steps. Choose the request method.
Expression: Used for Condition steps. Define the rule that decides the next path.
Select a form...: Used for Assign Form steps. Select the form to assign. This field is required.
Select groups: Used for Add to Groups and Remove from Groups steps. At least one group is required for Add to Groups.
Select a career...: Used for Assign Career steps. This field is required.
Career Category: Used for Assign Career steps when a category is needed. This field is required when shown.
Relative to: Used for steps that depend on timing. Choose the reference point for the delay. If you do not want a relative delay, use the absolute delay option.
Recipient: Used for steps that send something to a person. This field is required.
How do I know if a step or automation is valid?
Required fields are checked when you save. If a field is missing, complete the value shown next to it before you save again.
For timing steps, make sure the duration is valid and the unit is selected. For group and career actions, select at least one valid target. For email and notification steps, fill in the content fields before saving.
You can review the automation later in Automation Details, where the trigger, status, and pipeline steps are shown together.