Skip to main content

Automation Run

Status: Trusted Tester

An Automation run is the instance of an automation executing its steps for a business location. You may configure the automation definition and obtain its ID within Partner Center.

typestringrequired

Possible values: [automationRuns]

Default value: automationRuns
Example: automationRuns
relationships objectrequired
automation objectrequired

A link to the automation definition that is being run.

data objectrequired
typestringrequired
Default value: automations
Example: automations
idstringrequired

Possible values: Value must match regular expression ^Automation-

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

Deprecated: Pass the businessLocation.id in the attributes.entityId field instead.

A link to the business location that this automation is being run for. Either the businessLocation or order is required. (It depends on the automation type.)

data object
typestringrequired
Default value: businessLocations
Example: businessLocations
idstringrequired
Example: AG-1234567
order objectdeprecated

Deprecated: Pass the order.id in the attributes.entityId field instead.

A link to the order that this automation is being run for. Either the businessLocation or order is required. (It depends on the automation type.)

data object
typestringrequired

Possible values: [orders]

Default value: orders
idstringrequired
Example: AG-1234:ORD-1234567
attributes object
entityIdstring

The ID of the primary record that this automation relates to. It is used for reporting and rate limiting.

For automations using the Triggered manually for a contact trigger it should contain a contact id.

For automations using the Triggered manually for a order trigger it should contain an order id.

For automations using the A webhook is received trigger it may be left blank.

dataobject

Extra data that you would like to send to the automation. The automation trigger must also be configured correctly to be able to read these values.

Automation Run
{
  "type": "automationRuns",
  "relationships": {
    "automation": {
      "data": {
        "type": "automations",
        "id": "Automation-91cb048c-c498-43ba-ab99-2ca2d27d2c46"
      }
    }
  },
  "attributes": {
    "entityId": "string",
    "data": {}
  }
}