Automation

Status: Trusted Tester

An Automation is a trigger and set of actions performed when the trigger is activated.

typestringrequired

Possible values: [automations]

Default value: automations

Example: automations

idstringrequired

Possible values: Value must match regular expression ^Automation-

Example: Automation-91cb048c-c498-43ba-ab99-2ca2d27d2c46

attributes object

namestring

The name of the automation

Example: Example Automation

triggerstring

The triggering action for the automation

Possible values: [TaskDefinition-manual-api-order-trigger, TaskDefinition-manual-api-account-trigger]

Example: TaskDefinition-manual-account-trigger

statusstring

The current status of the automation, one of: on, off, draining

Possible values: [on, draining, off]

Example: on

tagsstring[]

A list of user-defined tags on the automation

customParameters object[]

Array [

typestring

Data type of the parameter

Possible values: [string, boolean]

idstring

namestring

]

Automation

{
  "type": "automations",
  "id": "Automation-91cb048c-c498-43ba-ab99-2ca2d27d2c46",
  "attributes": {
    "name": "Example Automation",
    "trigger": "TaskDefinition-manual-account-trigger",
    "status": "on",
    "tags": [
      "example-tag"
    ],
    "customParameters": [
      {
        "type": "string",
        "id": "string",
        "name": "string"
      }
    ]
  }
}