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.

Common Event Attributes

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 isn’t 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 isn’t 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.

Automation Started Status Event

This example shows the payload that your callback receives for a SendEvents.AutomationInstanceStarted event.

Started Status Info Attributes

Attribute	Type	Description
info.automationInstanceStartTimeUTC	number	The start time for the automation in UTC.

Automation Started Status Event Payload Example

1{
2  "automationCustomerKey": "650f2ab4-9d4b-421c-b091-bc11838836a5",
3  "automationInstanceId": "c111a1e2-6f1f-4b27-a62e-d2cfb05ba365",
4  "automationInstanceStatus": "Initialized",
5  "automationName": "My Automation",
6  "automationType": "scheduled",
7  "eid": 123456,
8  "eventCategoryType": "SendEvents",
9  "mid": 123456,
10  "timestampUTC": 1684943402352,
11  "info": {
12    "automationInstanceFileLocation": "",
13    "automationInstanceFilenameFromTrigger": "",
14    "automationInstanceRelativePath": "",
15    "automationInstanceScheduledTimeUTC": 0,
16    "automationInstanceStartTimeUTC": 1684943402305
17  }
18}

Automation Completed Status Event

This example shows the payload that your callback receives for a SendEvents.AutomationInstanceCompleted event.

Completed Status Info Attributes

Attribute	Type	Description
info.automationInstanceStartTimeUTC	number	The start time for the automation in UTC.
info.automationInstanceEndTimeUTC	number	The end time for the automation in UTC.

Automation Completed Status Event Payload Example

1{
2  "automationCustomerKey": "650f2ab4-9d4b-421c-b091-bc11838836a5",
3  "automationInstanceId": "c111a1e2-6f1f-4b27-a62e-d2cfb05ba365",
4  "automationInstanceStatus": "Complete",
5  "automationName": "My Automation",
6  "automationType": "scheduled",
7  "eid": 123456,
8  "eventCategoryType": "SendEvents",
9  "mid": 123456,
10  "timestampUTC": 1684943406408,
11  "info": {
12    "automationInstanceEndTimeUTC": 1684943406126,
13    "automationInstanceFileLocation": "",
14    "automationInstanceFilenameFromTrigger": "",
15    "automationInstanceRelativePath": "",
16    "automationInstanceScheduledTimeUTC": 0,
17    "automationInstanceStartTimeUTC": 1684943402307
18  }
19}

Automation Stopped Status Event

This example shows the payload that your callback receives for a SendEvents.AutomationInstanceStopped event.

Stopped Status Info Attributes

Attribute	Type	Description
info.automationInstanceStartTimeUTC	number	The start time for the automation in UTC.
info.automationInstanceEndTimeUTC	number	The end time for the automation in UTC.

Automation Stopped Status Event Payload Example

1{
2  "automationCustomerKey": "4aab2aa4-82d9-0597-7a1c-c0f2b4411945",
3  "automationInstanceId": "023d61c5-fcbd-4786-8b4f-90c6897f2394",
4  "automationInstanceStatus": "Stopped",
5  "automationName": "My Automation",
6  "automationType": "scheduled",
7  "eid": 123456,
8  "eventCategoryType": "SendEvents",
9  "mid": 123456,
10  "timestampUTC": 1684943825351,
11  "info": {
12    "automationInstanceEndTimeUTC": 1684943824491,
13    "automationInstanceFileLocation": "",
14    "automationInstanceFilenameFromTrigger": "",
15    "automationInstanceRelativePath": "",
16    "automationInstanceScheduledTimeUTC": 0,
17    "automationInstanceStartTimeUTC": 1684943822310
18  }
19}

Automation Errored Status Event

This example shows the payload that your callback receives for a SendEvents.AutomationInstanceErrored event.

Errored Status Info Attributes

Attribute	Type	Description
info.automationInstanceStartTimeUTC	number	The start time for the automation in UTC.
info.automationInstanceEndTimeUTC	number	The end time for the 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.

Automation Errored Status Event Payload Example

1{
2  "automationCustomerKey": "4aab2aa4-82d9-0597-7a1c-c0f2b4411945",
3  "automationInstanceId": "9db74119-fc8b-4cd1-847a-9e9829b2419d",
4  "automationInstanceStatus": "Error",
5  "automationName": "My Automation",
6  "automationType": "scheduled",
7  "eid": 123456,
8  "eventCategoryType": "SendEvents",
9  "mid": 123456,
10  "timestampUTC": 1684943972041,
11  "info": {
12    "automationInstanceEndTimeUTC": 1684943971837,
13    "automationInstanceFileLocation": "",
14    "automationInstanceFilenameFromTrigger": "",
15    "automationInstanceRelativePath": "",
16    "automationInstanceScheduledTimeUTC": 0,
17    "automationInstanceStartTimeUTC": 1684943955663,
18    "activity": {
19      "name": "My Script Activity",
20      "type": "0",
21      "instanceId": "a2c2503a-c6f9-401f-af00-9a607fa50327",
22      "step": "0",
23      "startTimeUTC": 1684943955727,
24      "endTimeUTC": 1684943971807,
25      "errorDetails": "A runtime error occurred while the SSJS Activity executed the SSJS script. Please review the SSJS activity to ensure that errors are handled properly."
26    }
27  }
28}

Automation Skipped Status Event

Automation Skipped Status Event Payload Example

1{
2  "automationCustomerKey": "4aab2aa4-82d9-0597-7a1c-c0f2b4411945",
3  "automationInstanceId": "b2c98cd9-acae-496e-bb4d-2f95a1cd2648",
4  "automationInstanceStatus": "Skipped",
5  "automationName": "My Automation",
6  "automationType": "scheduled",
7  "eid": 123456,
8  "eventCategoryType": "SendEvents",
9  "mid": 123456,
10  "timestampUTC": 1684945203310,
11  "info": {
12    "automationInstanceFileLocation": "",
13    "automationInstanceFilenameFromTrigger": "",
14    "automationInstanceRelativePath": "",
15    "automationInstanceScheduledTimeUTC": 0
16  }
17}