An Event represents a change or an action performed on a resource, for example an Import API resource.
Events are available for EventTypes specific to a resource. Common fields are represented by a base resource, Event.
Each Event has a data
field containing Event Data. This data is specific to a particular change or action.
You can access Events by subscribing to them with a Subscription.
Representations
Event
Base representation of an Event containing common fields to all Event Types.
id String | Unique identifier of the Event. |
notificationType String | "Event" |
resourceType | The type of resource targeted by the Event. |
type | The type of Event that has occurred. |
data Object | An object containing details related to the Event. |
createdAt DateTime | Date and time (UTC) the Event was generated. |
EventType
Type of events supported by EventSubscriptions.
ImportContainerCreated
ImportContainerDeleted
ImportOperationRejected
ImportUnresolved
ImportValidationFailed
ImportWaitForMasterVariant
Import API Events
Events that represent a change or an action related to the Import API.
Events
Import Container Created Event
Generated when an Import Container is created.
id String | Unique identifier of the Event. |
notificationType String | "Event" |
resourceType | import-api |
type | ImportContainerCreated The type of Event that has occurred. |
An object containing details of the created Import Container. | |
createdAt DateTime | Date and time (UTC) the Event was generated. |
{
"id": "3b364ca2-cbe5-42b4-a85a-37d4e57d659e",
"notificationType": "Event",
"resourceType": "import-api",
"type": "ImportContainerCreated",
"data": {
"version": 1,
"key": "my-import-container",
"createdAt": "2025-03-26T17:28:20.376Z",
"lastModifiedAt": "2025-03-26T17:28:20.376Z"
},
"createdAt": "2025-03-26T17:28:20.397Z"
}
Import Container Deleted Event
Generated when an Import Container is deleted.
id String | Unique identifier of the Event. |
notificationType String | "Event" |
resourceType | import-api |
type | ImportContainerDeleted The type of Event that has occurred. |
An object containing details of the deleted Import Container. | |
createdAt DateTime | Date and time (UTC) the Event was generated. |
{
"id": "3b364ca2-cbe5-42b4-a85a-37d4e57d659e",
"notificationType": "Event",
"resourceType": "import-api",
"type": "ImportContainerDeleted",
"data": {
"version": 1,
"key": "my-import-container"
},
"createdAt": "2025-03-26T17:28:20.397Z"
}
Import Operation Rejected Event
Generated when an Import Operation has the rejected
ProcessingState.
id String | Unique identifier of the Event. |
notificationType String | "Event" |
resourceType | import-api |
type | ImportOperationRejected The type of Event that has occurred. |
An object containing details of the Import Operation with the | |
createdAt DateTime | Date and time (UTC) the Event was generated. |
{
"id": "3b364ca2-cbe5-42b4-a85a-37d4e57d659e",
"notificationType": "Event",
"resourceType": "import-api",
"type": "ImportOperationRejected",
"data": {
"id": "663dfd28-0359-45b0-b77a-9e7af1dd19ae"
},
"createdAt": "2025-03-26T17:28:20.397Z"
}
Import Unresolved Event
Generated when an Import Operation has the unresolved
ProcessingState.
id String | Unique identifier of the Event. |
notificationType String | "Event" |
resourceType | import-api |
type | ImportUnresolved The type of Event that has occurred. |
An object containing details of the Import Operation with the | |
createdAt DateTime | Date and time (UTC) the Event was generated. |
{
"id": "3b364ca2-cbe5-42b4-a85a-37d4e57d659e",
"notificationType": "Event",
"resourceType": "import-api",
"type": "ImportUnresolved",
"data": {
"id": "663dfd28-0359-45b0-b77a-9e7af1dd19ae",
"version": 1,
"importContainerKey": "my-import-container"
},
"createdAt": "2025-03-26T17:28:20.397Z"
}
Import Validation Failed Event
Generated when an Import Operation has the validationFailed
ProcessingState.
id String | Unique identifier of the Event. |
notificationType String | "Event" |
resourceType | import-api |
type | ImportValidationFailed The type of Event that has occurred. |
An object containing details of the Import Operation with the | |
createdAt DateTime | Date and time (UTC) the Event was generated. |
{
"id": "3b364ca2-cbe5-42b4-a85a-37d4e57d659e",
"notificationType": "Event",
"resourceType": "import-api",
"type": "ImportValidationFailed",
"data": {
"id": "663dfd28-0359-45b0-b77a-9e7af1dd19ae",
"version": 1,
"importContainerKey": "my-import-container"
},
"createdAt": "2025-03-26T17:28:20.397Z"
}
Import Wait For Master Variant Event
Generated when an Import Operation has the waitForMasterVariant
ProcessingState.
id String | Unique identifier of the Event. |
notificationType String | "Event" |
resourceType | import-api |
type | ImportWaitForMasterVariant The type of Event that has occurred. |
An object containing details of the Import Operation with the | |
createdAt DateTime | Date and time (UTC) the Event was generated. |
{
"id": "3b364ca2-cbe5-42b4-a85a-37d4e57d659e",
"notificationType": "Event",
"resourceType": "import-api",
"type": "ImportWaitForMasterVariant",
"data": {
"id": "663dfd28-0359-45b0-b77a-9e7af1dd19ae",
"version": 1,
"importContainerKey": "my-import-container"
},
"createdAt": "2025-03-26T17:28:20.397Z"
}
Event Data
Import Container Created Event Data
The data
of the Import Container Created Event.
version Int | The |
key String | The |
createdAt DateTime | Date and time (UTC) the Import Container was created. |
lastModifiedAt DateTime | Date and time (UTC) the Import Container was last updated. |
{
"version": 1,
"key": "my-import-container",
"createdAt": "2025-03-26T17:28:20.376Z",
"lastModifiedAt": "2025-03-26T17:28:20.376Z"
}
Import Container Deleted Event Data
The data
of the Import Container Deleted Event.
version Int | The |
key String | The |
{
"version": 1,
"key": "my-import-container"
}
Import Operation Rejected Event Data
The data
of the Import Operation Rejected Event.
id String | The |
{
"id": "663dfd28-0359-45b0-b77a-9e7af1dd19ae"
}
Import Validation Failed Event Data
The data
of the Import Validation Failed Event.
id String | The |
version Int | The |
importContainerKey String | The |
{
"id": "663dfd28-0359-45b0-b77a-9e7af1dd19ae",
"version": 1,
"importContainerKey": "my-import-container"
}
Import Unresolved Event Data
The data
of the Import Unresolved Event.
id String | The |
version Int | The |
importContainerKey String | The |
{
"id": "663dfd28-0359-45b0-b77a-9e7af1dd19ae",
"version": 1,
"importContainerKey": "my-import-container"
}
Import Wait For Master Variant Event Data
The data
of the Import Wait For Master Variant Event.
id String | The |
version Int | The |
importContainerKey String | The |
{
"id": "663dfd28-0359-45b0-b77a-9e7af1dd19ae",
"version": 1,
"importContainerKey": "my-import-container"
}