Automations

Automations allow you to react to changes in the system, and execute actions. You can read more about Automations by reading our Introduction to Automations guide.

Automation Types

ExecuteAutomationOptions

{
  variables: Record<string, string>,
  skipEvaluation: boolean
}

executeAutomation

Read-only Mode

This function is not available in read-only mode.

Execute an Automation.

executeAutomation(automationId, options)

Parameters

Name	Type	Description	Optional
automationId	string	The identifier of the Automation.	❌
options	ExecuteAutomationOptions	Options while executing the Automation.	✔

Returns A boolean on whether the Automation executed or not.

Example

// Execute another Automation with some variables
var exeucted = executeAutomation('7962d556-17a3-4481-81e1-945d18bd91e2', {
  variables: {
    "type": "system",
    "city": "Radbourne"
  }
});

if (executed) {
  // The Automation successfully executed
}