Automation Studio Events
The Engagement Event Notification Service supports these Automation Studio instance event notification types and their corresponding payloads.
| Notification Event Category | Notification Event Type | Description |
|---|---|---|
| SendEvents | AutomationInstanceStarted | Indicates that an automation instance has started. |
| SendEvents | AutomationInstanceCompleted | Indicates that an automation instance has completed. |
| SendEvents | AutomationInstanceStopped | Indicates that an automation instance has stopped. |
| SendEvents | AutomationInstanceErrored | Indicates that an automation instance has stopped due to an error. |
| SendEvents | AutomationInstanceSkipped | Indicates that an automation instance has been skipped. |
These are the attributes shared for AutomationInstanceStatusEvent.
| Attribute | Type | Description |
|---|---|---|
| eventCategoryType | string | The taxonomy of the event. |
| timestampUTC | number | UTC Epoch time. |
| eid | number | Tenant Enterprise Id from which the event was produced. |
| mid | number | Tenant Business Unit Id from which the event was produced. |
| automationName | string | Name of the automation. |
| automationCustomerKey | string | CustomerKey set by the customer. |
| automationType | string | The type of automation - FileDrop, Trigger, or Schedule. |
| automationInstanceID | string | The unique identifier of the automation's instance. |
| automationInstanceStatus | string | The status of Automation. |
| info.automationInstanceFilenameFromTrigger | string | The file name that was being processed. This field is set for file drop and automation trigger automations. It is not set for scheduled automations. |
| info.automationInstanceFileLocation | string | The name of the file transfer location that was used to retrieve the file for automation trigger automations. This field is not set for other automation types. |
| info.automationInstanceRelativePath | string | The relative path was used to retrieve the file based on the initial directory of the file transfer location. This field is only applicable to automation trigger automations. |
| info.automationInstanceScheduledTimeUTC | number | Scheduled time for Scheduled automations in UTC. |
This event notification payload is an example what your callback receives for a SendEvents.AutomationInstanceStarted event.
| Attribute | Type | Description |
|---|---|---|
| info.automationInstanceStartTimeUTC | number | Start time for automation in UTC. |
This event notification payload is an example what your callback receives for a SendEvents.AutomationInstanceCompleted event.
| Attribute | Type | Description |
|---|---|---|
| info.automationInstanceStartTimeUTC | number | Start time for automation in UTC. |
| info.automationInstanceEndTimeUTC | number | End time for automation in UTC. |
This event notification payload is an example what your callback receives for a SendEvents.AutomationInstanceStopped event.
| Attribute | Type | Description |
|---|---|---|
| info.automationInstanceStartTimeUTC | number | Start time for automation in UTC. |
| info.automationInstanceEndTimeUTC | number | End time for automation in UTC. |
This event notification payload is an example what your callback receives for a SendEvents.AutomationInstanceErrored event.
| Attribute | Type | Description |
|---|---|---|
| info.automationInstanceStartTimeUTC | number | Start time for automation in UTC. |
| info.automationInstanceEndTimeUTC | number | End time for automation in UTC. |
| info.activity.name | string | Name of the activity. |
| info.activity.type | string | The type of activity. Values could be, query, import, file transfer, and so on. |
| info.activity.customerKey | string | The customer key set on the activity. |
| info.activity.ID | string | The unique identifier of the activity. |
| info.activity.instanceID | string | The unique identifier of the activity instance. |
| info.activity.step | number | The activity's step in the automation. |
| info.activity.startTimeUTC | number | The activity start time in UTC. |
| info.activity.endTimeUTC | number | The activity end time in UTC. |
| info.activity.errorDetails | string | The first erroring activity details. |