--- schema_version: "1" id: f1084936ed7397be8929863efd3361ad1d194d6f06ed63624c50bd677e7df8bb title: Automation Studio Events collection: developer version: current locale: en-us portal_url: https://docs.salesforce.com/developer/current/en-us/marketing-cloud/guides/mc-apis/automation_studio_events.md canonical_url: https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/automation_studio_events.html source_site: developer.salesforce.com content_type: documentation content_hash: 70e06f43af5dcac323274f5fd482e79f5c44904162729f5bcccfd2dcd6f51852 products: - Marketing Cloud Engagement APIs and Programmatic Languages - Marketing Cloud --- # 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 ```json { "automationCustomerKey": "650f2ab4-9d4b-421c-b091-bc11838836a5", "automationInstanceId": "c111a1e2-6f1f-4b27-a62e-d2cfb05ba365", "automationInstanceStatus": "Initialized", "automationName": "My Automation", "automationType": "scheduled", "eid": 123456, "eventCategoryType": "SendEvents", "mid": 123456, "timestampUTC": 1684943402352, "info": { "automationInstanceFileLocation": "", "automationInstanceFilenameFromTrigger": "", "automationInstanceRelativePath": "", "automationInstanceScheduledTimeUTC": 0, "automationInstanceStartTimeUTC": 1684943402305 } } ``` ## 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 ```json { "automationCustomerKey": "650f2ab4-9d4b-421c-b091-bc11838836a5", "automationInstanceId": "c111a1e2-6f1f-4b27-a62e-d2cfb05ba365", "automationInstanceStatus": "Complete", "automationName": "My Automation", "automationType": "scheduled", "eid": 123456, "eventCategoryType": "SendEvents", "mid": 123456, "timestampUTC": 1684943406408, "info": { "automationInstanceEndTimeUTC": 1684943406126, "automationInstanceFileLocation": "", "automationInstanceFilenameFromTrigger": "", "automationInstanceRelativePath": "", "automationInstanceScheduledTimeUTC": 0, "automationInstanceStartTimeUTC": 1684943402307 } } ``` ## 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 ```json { "automationCustomerKey": "4aab2aa4-82d9-0597-7a1c-c0f2b4411945", "automationInstanceId": "023d61c5-fcbd-4786-8b4f-90c6897f2394", "automationInstanceStatus": "Stopped", "automationName": "My Automation", "automationType": "scheduled", "eid": 123456, "eventCategoryType": "SendEvents", "mid": 123456, "timestampUTC": 1684943825351, "info": { "automationInstanceEndTimeUTC": 1684943824491, "automationInstanceFileLocation": "", "automationInstanceFilenameFromTrigger": "", "automationInstanceRelativePath": "", "automationInstanceScheduledTimeUTC": 0, "automationInstanceStartTimeUTC": 1684943822310 } } ``` ## 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 ```json { "automationCustomerKey": "4aab2aa4-82d9-0597-7a1c-c0f2b4411945", "automationInstanceId": "9db74119-fc8b-4cd1-847a-9e9829b2419d", "automationInstanceStatus": "Error", "automationName": "My Automation", "automationType": "scheduled", "eid": 123456, "eventCategoryType": "SendEvents", "mid": 123456, "timestampUTC": 1684943972041, "info": { "automationInstanceEndTimeUTC": 1684943971837, "automationInstanceFileLocation": "", "automationInstanceFilenameFromTrigger": "", "automationInstanceRelativePath": "", "automationInstanceScheduledTimeUTC": 0, "automationInstanceStartTimeUTC": 1684943955663, "activity": { "name": "My Script Activity", "type": "0", "instanceId": "a2c2503a-c6f9-401f-af00-9a607fa50327", "step": "0", "startTimeUTC": 1684943955727, "endTimeUTC": 1684943971807, "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." } } } ``` ## Automation Skipped Status Event ### Automation Skipped Status Event Payload Example ```json { "automationCustomerKey": "4aab2aa4-82d9-0597-7a1c-c0f2b4411945", "automationInstanceId": "b2c98cd9-acae-496e-bb4d-2f95a1cd2648", "automationInstanceStatus": "Skipped", "automationName": "My Automation", "automationType": "scheduled", "eid": 123456, "eventCategoryType": "SendEvents", "mid": 123456, "timestampUTC": 1684945203310, "info": { "automationInstanceFileLocation": "", "automationInstanceFilenameFromTrigger": "", "automationInstanceRelativePath": "", "automationInstanceScheduledTimeUTC": 0 } } ```