Automation Studio Events

The Engagement Event Notification Service supports these Automation Studio instance event notification types and their corresponding payloads.

Notification Event CategoryNotification Event TypeDescription
SendEventsAutomationInstanceStartedIndicates that an automation instance has started.
SendEventsAutomationInstanceCompletedIndicates that an automation instance has completed.
SendEventsAutomationInstanceStoppedIndicates that an automation instance has stopped.
SendEventsAutomationInstanceErroredIndicates that an automation instance has stopped due to an error.
SendEventsAutomationInstanceSkippedIndicates that an automation instance has been skipped.

These are the attributes shared for AutomationInstanceStatusEvent.

AttributeTypeDescription
eventCategoryTypestringThe taxonomy of the event.
timestampUTCnumberUTC Epoch time.
eidnumberTenant Enterprise Id from which the event was produced.
midnumberTenant Business Unit Id from which the event was produced.
automationNamestringName of the automation.
automationCustomerKeystringCustomerKey set by the customer.
automationTypestringThe type of automation - FileDrop, Trigger, or Schedule.
automationInstanceIDstringThe unique identifier of the automation's instance.
automationInstanceStatusstringThe status of Automation.
info.automationInstanceFilenameFromTriggerstringThe 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.automationInstanceFileLocationstringThe 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.automationInstanceRelativePathstringThe 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.automationInstanceScheduledTimeUTCnumberScheduled time for Scheduled automations in UTC.

This event notification payload is an example what your callback receives for a SendEvents.AutomationInstanceStarted event.

AttributeTypeDescription
info.automationInstanceStartTimeUTCnumberStart time for automation in UTC.

This event notification payload is an example what your callback receives for a SendEvents.AutomationInstanceCompleted event.

AttributeTypeDescription
info.automationInstanceStartTimeUTCnumberStart time for automation in UTC.
info.automationInstanceEndTimeUTCnumberEnd time for automation in UTC.

This event notification payload is an example what your callback receives for a SendEvents.AutomationInstanceStopped event.

AttributeTypeDescription
info.automationInstanceStartTimeUTCnumberStart time for automation in UTC.
info.automationInstanceEndTimeUTCnumberEnd time for automation in UTC.

This event notification payload is an example what your callback receives for a SendEvents.AutomationInstanceErrored event.

AttributeTypeDescription
info.automationInstanceStartTimeUTCnumberStart time for automation in UTC.
info.automationInstanceEndTimeUTCnumberEnd time for automation in UTC.
info.activity.namestringName of the activity.
info.activity.typestringThe type of activity. Values could be, query, import, file transfer, and so on.
info.activity.customerKeystringThe customer key set on the activity.
info.activity.IDstringThe unique identifier of the activity.
info.activity.instanceIDstringThe unique identifier of the activity instance.
info.activity.stepnumberThe activity's step in the automation.
info.activity.startTimeUTCnumberThe activity start time in UTC.
info.activity.endTimeUTCnumberThe activity end time in UTC.
info.activity.errorDetailsstringThe first erroring activity details.