The Event Platform
#Available events
#com.akeneo.pim.v1.app.deleted
This event is generated whenever an App is deleted from the PIM.
- Message ID:
com.akeneo.pim.v1.app.deleted - Content type: application/json
#Payload
| Name | Type | Description |
|---|---|---|
| data.app | object | - |
| data.app.client_id | string | Unique identifier of an App in the PIM. |
| data.author | object | - |
| data.author.identifier | string | Identifier of the author. |
| data.author.type | string | Type of the author (user, api, job, system, ai-assistant or unknown-user-type). |
Example of payload
{
"specversion": "1.0",
"id": "018e32f9-dfe4-760e-a273-5da1c089dfdb",
"type": "com.akeneo.pim.v1.app.deleted",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-02-22T17:31:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.app.deleted.schema.json",
"data": {
"app": {
"client_id": "test_client_id"
},
"author": {
"identifier": "julia",
"type": "user"
}
}
}
#com.akeneo.pim.v1.asset.created
This event is generated whenever a new asset is created in the PIM.
- Message ID:
com.akeneo.pim.v1.asset.created - Content type: application/json
#Payload
| Name | Type | Description |
|---|---|---|
| data.asset | object | - |
| data.asset.asset_family | object | - |
| data.asset.asset_family.code | string | code of an asset family |
| data.asset.code | string | code of an asset |
| data.author | object | - |
| data.author.identifier | string | Identifier of the author. |
| data.author.type | string | Type of the author (user, api, job, system, ai-assistant or unknown-user-type). |
Example of payload
{
"specversion": "1.0",
"id": "018e32f9-dfe4-760e-a273-5da1c089dfdb",
"type": "com.akeneo.pim.v1.asset.created",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-02-22T17:31:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.asset.created.schema.json",
"data": {
"asset": {
"asset_family": {
"code": "family1"
},
"code": "asset1"
},
"author": {
"identifier": "401ad939-cd20-4343-8b61-3348a53feb4f",
"type": "user"
}
}
}
#com.akeneo.pim.v1.asset.updated
This event is generated whenever an existing asset is modified in the PIM.
- Message ID:
com.akeneo.pim.v1.asset.updated - Content type: application/json
Only changes in asset values will cause this event.
#Payload
| Name | Type | Description |
|---|---|---|
| data.asset | object | - |
| data.asset.asset_family | object | - |
| data.asset.asset_family.code | string | code of an asset family |
| data.asset.code | string | code of an asset |
| data.author | object | - |
| data.author.identifier | string | Identifier of the author. |
| data.author.type | string | Type of the author (user, api, job, system, ai-assistant or unknown-user-type). |
Example of payload
{
"specversion": "1.0",
"id": "018e32f9-dfe4-760e-a273-5da1c089dfdb",
"type": "com.akeneo.pim.v1.asset.updated",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-02-22T17:31:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.asset.updated.schema.json",
"data": {
"asset": {
"asset_family": {
"code": "family1"
},
"code": "asset1"
},
"author": {
"identifier": "b238e9f7-fcec-45bd-9431-d43cd624b244",
"type": "user"
}
}
}
#com.akeneo.pim.v1.asset.updated.delta
This event is generated whenever an existing asset is modified in the PIM.
- Message ID:
com.akeneo.pim.v1.asset.updated.delta - Content type: application/json
The following actions can trigger an asset update delta event:
- Asset update from the asset page.
- Asset update using the REST API.
The modifications that can lead to this event include:
- Adjustments to asset attribute values
- Changes to asset properties (status, start_date, end_date)
#Payload
| Name | Type | Description |
|---|---|---|
| data.asset | object | - |
| data.asset.asset_family | object | - |
| data.asset.asset_family.code | string | Unique identifier of an Asset Family in the PIM. |
| data.asset.code | string | Unique identifier of an Asset within its Asset Family in the PIM. |
| data.asset.changes | object | Details about the changes made to the asset. |
| data.asset.changes.values | object | Changes to asset attribute values, keyed by attribute code. |
| data.asset.changes.values (additional properties) | array<object> | - |
| data.asset.changes.values.previous | string | number | boolean | object | array<any> | null | The previous value before the change. Null if the attribute was added. |
| data.asset.changes.values.new | string | number | boolean | object | array<any> | null | The new value after the change. Null if the attribute was removed. |
| data.asset.changes.values.type | string | The type of the attribute. |
| data.asset.changes.values.locale | string | null | The locale of the attribute value. Null if the attribute is not localizable. |
| data.asset.changes.values.channel | string | null | The channel of the attribute value. Null if the attribute is not scopable. |
| data.asset.changes.properties | object | Changes to asset properties (status, start_date, end_date). |
| data.asset.changes.properties (additional properties) | object | - |
| data.asset.changes.properties.previous | string | null | The previous property value before the change. Null if the property was not set. |
| data.asset.changes.properties.new | string | null | The new property value after the change. Null if the property was removed. |
| data.asset.changes.properties.type | string | The data type of the property. |
| data.author | object | - |
| data.author.identifier | string | Identifier of the author. |
| data.author.type | string | Type of the author (user, api, job, system, ai-assistant or unknown-user-type). |
Example of payload
{
"specversion": "1.0",
"id": "018e32f9-dfe4-760e-a273-5da1c089dfdb",
"type": "com.akeneo.pim.v1.asset.updated.delta",
"source": "pim",
"subject": "01948d3c-6625-7833-8a03-dd96245862d3",
"time": "2025-12-16T15:06:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.asset.updated.delta.schema.json",
"data": {
"asset": {
"asset_family": {
"code": "asset_family_code"
},
"code": "asset_code",
"changes": {
"values": {
"an_added_attribute": [
{
"previous": null,
"new": "new_data",
"type": "text",
"locale": "a_locale",
"channel": "a_channel"
}
],
"an_updated_attribute": [
{
"previous": "previous_data",
"new": "new_data",
"type": "text",
"locale": "a_locale",
"channel": "a_channel"
}
],
"a_removed_attribute": [
{
"previous": "previous_data",
"new": null,
"type": "text",
"locale": "a_locale",
"channel": "a_channel"
}
],
"an_attribute_with_value_by_locale": [
{
"previous": "previous_data_for_a_locale",
"new": "new_data_for_a_locale",
"type": "text",
"locale": "a_locale",
"channel": "a_channel"
},
{
"previous": "previous_data_for_another_locale",
"new": "new_data_for_another_locale",
"type": "text",
"locale": "another_locale",
"channel": "a_channel"
}
],
"an_attribute_with_value_by_channel": [
{
"previous": "previous_data_for_a_channel",
"new": "new_data_for_a_channel",
"type": "text",
"locale": "a_locale",
"channel": "a_channel"
},
{
"previous": "previous_data_for_another_channel",
"new": "new_data_for_another_channel",
"type": "text",
"locale": "a_locale",
"channel": "another_channel"
}
],
"a_text_attribute": [
{
"previous": "previous_text",
"new": "new_text",
"type": "text",
"locale": "a_locale",
"channel": "a_channel"
}
],
"a_media_file_attribute": [
{
"previous": "7/a/2/b/7a2b175efd1d0a2a09c0c4e04be398dbb7a3e02e_old_packshot.jpg",
"new": "7/a/2/b/7a2b175efd1d0a2a09c0c4e04be398dbb7a3e02e_new_packshot.jpg",
"type": "media_file",
"locale": "a_locale",
"channel": "a_channel"
}
],
"a_multiple_options_attribute": [
{
"previous": [
"previous_option_1",
"previous_option_2"
],
"new": [
"new_option_1",
"new_option_2"
],
"type": "multiple_options",
"locale": "a_locale",
"channel": "a_channel"
}
],
"a_record_attribute": [
{
"previous": "previous_record_code",
"new": "new_record_code",
"type": "record",
"locale": "a_locale",
"channel": "a_channel"
}
],
"a_number_attribute": [
{
"previous": "1234",
"new": "4321",
"type": "number",
"locale": "a_locale",
"channel": "a_channel"
}
],
"a_single_option_attribute": [
{
"previous": "previous_option",
"new": "new_option",
"type": "single_option",
"locale": "a_locale",
"channel": "a_channel"
}
],
"a_media_link_attribute": [
{
"previous": "previous_media_link",
"new": "new_media_link",
"type": "media_link",
"locale": "a_locale",
"channel": "a_channel"
}
],
"a_date_attribute": [
{
"previous": "2026-01-01T00:00:00+00:00",
"new": "2026-01-07T00:00:00+00:00",
"type": "date",
"locale": "a_locale",
"channel": "a_channel"
}
],
"a_boolean_attribute": [
{
"previous": true,
"new": false,
"type": "boolean",
"locale": "a_locale",
"channel": "a_channel"
}
],
"an_auto_tagging_attribute": [
{
"previous": [
"previous_tag_1",
"previous_tag_2"
],
"new": [
"new_tag_1",
"new_tag_2",
"new_tag_3"
],
"type": "auto_tagging",
"locale": null,
"channel": null
}
]
},
"properties": {
"status": {
"previous": "enabled",
"new": "disabled",
"type": "string"
},
"start_date": {
"previous": null,
"new": "2026-01-01",
"type": "date"
},
"end_date": {
"previous": null,
"new": "2026-01-02",
"type": "date"
}
}
}
},
"author": {
"identifier": "b238e9f7-fcec-45bd-9431-d43cd624b244",
"type": "user"
}
}
}
#com.akeneo.pim.v1.asset.deleted
This event is generated whenever an asset is deleted from the PIM.
- Message ID:
com.akeneo.pim.v1.asset.deleted - Content type: application/json
#Payload
| Name | Type | Description |
|---|---|---|
| data.asset | object | - |
| data.asset.asset_family | object | - |
| data.asset.asset_family.code | string | identifier of an asset family |
| data.asset.code | string | code of an asset |
| data.author | object | - |
| data.author.identifier | string | Identifier of the author. |
| data.author.type | string | Type of the author (user, api, job, system, ai-assistant or unknown-user-type). |
Example of payload
{
"specversion": "1.0",
"id": "018e32f9-dfe4-760e-a273-5da1c089dfdb",
"type": "com.akeneo.pim.v1.asset.deleted",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-02-22T17:31:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.asset.deleted.schema.json",
"data": {
"asset": {
"asset_family": {
"code": "family1"
},
"code": "asset1"
},
"author": {
"identifier": "401ad939-cd20-4343-8b61-3348a53feb4f",
"type": "user"
}
}
}
#com.akeneo.pim.v1.attribute.created
This event is generated whenever a new attribute is created in the PIM.
- Message ID:
com.akeneo.pim.v1.attribute.created - Content type: application/json
#Payload
| Name | Type | Description |
|---|---|---|
| data.attribute | object | - |
| data.attribute.code | string | Unique identifier of an Attribute in the PIM. |
| data.author | object | - |
| data.author.identifier | string | Identifier of the author. |
| data.author.type | string | Type of the author (user, api, job, system, ai-assistant or unknown-user-type). |
Example of payload
{
"specversion": "1.0",
"id": "b6f4add4-f3d1-4502-8cf0-0f228e054ce5",
"type": "com.akeneo.pim.v1.attribute.created",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-06-10T17:31:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.attribute.created.schema.json",
"data": {
"attribute": {
"code": "an-attribute-code"
},
"author": {
"identifier": "b238e9f7-fcec-45bd-9431-d43cd624b244",
"type": "user"
}
}
}
#com.akeneo.pim.v1.attribute.updated
This event is generated whenever an existing attribute is modified in the PIM.
- Message ID:
com.akeneo.pim.v1.attribute.updated - Content type: application/json
This event is generated whenever an existing attribute is modified in the PIM. The updates that can trigger this event include the following:
- Update any attribute property and save.
- Reorder attributes within an attribute group (doing so will trigger an
com.akeneo.pim.v1.attribute.updatedevent for every attribute in the attribute group).
#Payload
| Name | Type | Description |
|---|---|---|
| data.attribute | object | - |
| data.attribute.code | string | Unique identifier of an Attribute in the PIM. |
| data.author | object | - |
| data.author.identifier | string | Identifier of the author. |
| data.author.type | string | Type of the author (user, api, job, system, ai-assistant or unknown-user-type). |
Example of payload
{
"specversion": "1.0",
"id": "b6f4add4-f3d1-4502-8cf0-0f228e054ce5",
"type": "com.akeneo.pim.v1.attribute.updated",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-06-10T17:31:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.attribute.updated.schema.json",
"data": {
"attribute": {
"code": "an-attribute-code"
},
"author": {
"identifier": "401ad939-cd20-4343-8b61-3348a53feb4f",
"type": "user"
}
}
}
#com.akeneo.pim.v1.attribute.deleted
This event is generated whenever an attribute is deleted from the PIM.
- Message ID:
com.akeneo.pim.v1.attribute.deleted - Content type: application/json
#Payload
| Name | Type | Description |
|---|---|---|
| data.attribute | object | - |
| data.attribute.code | string | Unique identifier of an Attribute in the PIM. |
| data.author | object | - |
| data.author.identifier | string | Identifier of the author. |
| data.author.type | string | Type of the author (user, api, job, system, ai-assistant or unknown-user-type). |
Example of payload
{
"specversion": "1.0",
"id": "b6f4add4-f3d1-4502-8cf0-0f228e054ce5",
"type": "com.akeneo.pim.v1.attribute.deleted",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-06-10T17:31:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.attribute.deleted.schema.json",
"data": {
"attribute": {
"code": "an-attribute-code"
},
"author": {
"identifier": "b238e9f7-fcec-45bd-9431-d43cd624b244",
"type": "user"
}
}
}
#com.akeneo.pim.v1.attribute-group.created
This event is generated whenever a new attribute group is created in the PIM.
- Message ID:
com.akeneo.pim.v1.attribute-group.created - Content type: application/json
#Payload
| Name | Type | Description |
|---|---|---|
| data.attribute_group | object | - |
| data.attribute_group.code | string | Unique identifier of an Attribute Group in the PIM. |
| data.author | object | - |
| data.author.identifier | string | Identifier of the author. |
| data.author.type | string | Type of the author (user, api, job, system, ai-assistant or unknown-user-type). |
Example of payload
{
"specversion": "1.0",
"id": "b6f4add4-f3d1-4502-8cf0-0f228e054ce5",
"type": "com.akeneo.pim.v1.attribute-group.created",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-06-10T17:31:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.attribute-group.created.schema.json",
"data": {
"attribute_group": {
"code": "an-attribute-group-code"
},
"author": {
"identifier": "admin",
"type": "user"
}
}
}
#com.akeneo.pim.v1.attribute-group.updated
This event is generated whenever an existing attribute group is modified in the PIM.
- Message ID:
com.akeneo.pim.v1.attribute-group.updated - Content type: application/json
#Payload
| Name | Type | Description |
|---|---|---|
| data.attribute_group | object | - |
| data.attribute_group.code | string | Unique identifier of an Attribute Group in the PIM. |
| data.author | object | - |
| data.author.identifier | string | Identifier of the author. |
| data.author.type | string | Type of the author (user, api, job, system, ai-assistant or unknown-user-type). |
Example of payload
{
"specversion": "1.0",
"id": "b6f4add4-f3d1-4502-8cf0-0f228e054ce5",
"type": "com.akeneo.pim.v1.attribute-group.updated",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-06-10T17:31:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.attribute-group.updated.schema.json",
"data": {
"attribute_group": {
"code": "an-attribute-group-code"
},
"author": {
"identifier": "b238e9f7-fcec-45bd-9431-d43cd624b244",
"type": "user"
}
}
}
#com.akeneo.pim.v1.attribute-group.deleted
This event is generated whenever an attribute group is deleted from the PIM.
- Message ID:
com.akeneo.pim.v1.attribute-group.deleted - Content type: application/json
#Payload
| Name | Type | Description |
|---|---|---|
| data.attribute_group | object | - |
| data.attribute_group.code | string | Unique identifier of an Attribute Group in the PIM. |
| data.author | object | - |
| data.author.identifier | string | Identifier of the author. |
| data.author.type | string | Type of the author (user, api, job, system, ai-assistant or unknown-user-type). |
Example of payload
{
"specversion": "1.0",
"id": "b6f4add4-f3d1-4502-8cf0-0f228e054ce5",
"type": "com.akeneo.pim.v1.attribute-group.deleted",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-06-10T17:31:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.attribute-group.deleted.schema.json",
"data": {
"attribute_group": {
"code": "an_attribute_group_code"
},
"author": {
"identifier": "the-connection-code",
"type": "api"
}
}
}
#com.akeneo.pim.v1.attribute-option.created
This event is generated whenever a new attribute option is created in the PIM.
- Message ID:
com.akeneo.pim.v1.attribute-option.created - Content type: application/json
#Payload
| Name | Type | Description |
|---|---|---|
| data.attribute_option | object | - |
| data.attribute_option.code | string | code of an attribute option |
| data.attribute_option.attribute | object | - |
| data.attribute_option.attribute.code | string | code of an attribute |
| data.author | object | - |
| data.author.identifier | string | Identifier of the author. |
| data.author.type | string | Type of the author (user, api, job, system, ai-assistant or unknown-user-type). |
Example of payload
{
"specversion": "1.0",
"id": "6e523497-8231-4892-8f9f-895378b4d045",
"type": "com.akeneo.pim.v1.attribute-option.created",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-06-13T10:17:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.reference-entity-record.created.schema.json",
"data": {
"attribute_option": {
"code": "an_attribute_option_code",
"attribute": {
"code": "an_attribute_code"
}
},
"author": {
"identifier": "5_xxxk00ufn688cc0gok0wwwxxxccc0g84cwwgkg4s00ow4oxxx",
"type": "api"
}
}
}
#com.akeneo.pim.v1.attribute-option.updated
This event is generated whenever an existing attribute option is updated in the PIM.
- Message ID:
com.akeneo.pim.v1.attribute-option.updated - Content type: application/json
#Payload
| Name | Type | Description |
|---|---|---|
| data.attribute_option | object | - |
| data.attribute_option.code | string | code of an attribute option |
| data.attribute_option.attribute | object | - |
| data.attribute_option.attribute.code | string | code of an attribute |
| data.author | object | - |
| data.author.identifier | string | Identifier of the author. |
| data.author.type | string | Type of the author (user, api, job, system, ai-assistant or unknown-user-type). |
Example of payload
{
"specversion": "1.0",
"id": "6e523497-8231-4892-8f9f-895378b4d045",
"type": "com.akeneo.pim.v1.attribute-option.updated",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-06-13T10:17:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.reference-entity-record.updated.schema.json",
"data": {
"attribute_option": {
"code": "an_attribute_option_code",
"attribute": {
"code": "an_attribute_code"
}
},
"author": {
"identifier": "92e5893f-468b-486a-9a7e-d8c656d0a79c",
"type": "user"
}
}
}
#com.akeneo.pim.v1.attribute-option.deleted
This event is generated whenever an attribute option is deleted from the PIM.
- Message ID:
com.akeneo.pim.v1.attribute-option.deleted - Content type: application/json
#Payload
| Name | Type | Description |
|---|---|---|
| data.attribute_option | object | - |
| data.attribute_option.code | string | code of an attribute option |
| data.attribute_option.attribute | object | - |
| data.attribute_option.attribute.code | string | code of an attribute |
| data.author | object | - |
| data.author.identifier | string | Identifier of the author. |
| data.author.type | string | Type of the author (user, api, job, system, ai-assistant or unknown-user-type). |
Example of payload
{
"specversion": "1.0",
"id": "6e523497-8231-4892-8f9f-895378b4d045",
"type": "com.akeneo.pim.v1.attribute-option.deleted",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-06-13T10:17:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.reference-entity-record.updated.schema.json",
"data": {
"attribute_option": {
"code": "an_attribute_option_code",
"attribute": {
"code": "an_attribute_code"
}
},
"author": {
"identifier": "system",
"type": "system"
}
}
}
#com.akeneo.pim.v1.attribute-option.updated.delta
This event is generated whenever an existing attribute option is updated in the PIM and includes the changed fields.
- Message ID:
com.akeneo.pim.v1.attribute-option.updated.delta - Content type: application/json
The event is triggered when any changes are made to the attribute option sort order or labels and includes a delta of the changes with previous and new values.
#Payload
| Name | Type | Description |
|---|---|---|
| data.attribute_option | object | - |
| data.attribute_option.code | string | code of an attribute option |
| data.attribute_option.attribute | object | - |
| data.attribute_option.attribute.code | string | code of an attribute |
| data.attribute_option.changes | object | Details about the changes made to the attribute option. |
| data.attribute_option.changes.sort_order | object | Change in the sort order of the attribute option. |
| data.attribute_option.changes.sort_order.previous | integer | null | Previous sort order value. |
| data.attribute_option.changes.sort_order.new | integer | null | New sort order value. |
| data.attribute_option.changes.labels | object | Dictionary of changed labels per locale with their previous and new values. |
| data.attribute_option.changes.labels (additional properties) | object | - |
| data.attribute_option.changes.labels.previous | string | null | Previous label value. |
| data.attribute_option.changes.labels.new | string | null | New label value. |
| data.author | object | - |
| data.author.identifier | string | Identifier of the author. |
| data.author.type | string | Type of the author (user, api, job, system, ai-assistant or unknown-user-type). |
Example of payload
{
"specversion": "1.0",
"id": "018e32f9-dfe4-760e-a273-5da1c089dfdb",
"type": "com.akeneo.pim.v1.attribute-option.updated.delta",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2026-04-15T08:00:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.attribute-option.updated.delta.schema.json",
"data": {
"attribute_option": {
"code": "option_code",
"attribute": {
"code": "attribute_code"
},
"changes": {
"sort_order": {
"previous": 10,
"new": 20
},
"labels": {
"en_US": {
"previous": "Old label",
"new": "New label"
},
"fr_FR": {
"previous": null,
"new": "Nouveau label"
}
}
}
},
"author": {
"identifier": "92e5893f-468b-486a-9a7e-d8c656d0a79c",
"type": "user"
}
}
}
#com.akeneo.pim.v1.category.created
This event is generated whenever a new category is created in the PIM.
- Message ID:
com.akeneo.pim.v1.category.created - Content type: application/json
#Payload
| Name | Type | Description |
|---|---|---|
| data.category | object | - |
| data.category.code | string | Unique identifier of a category |
| data.author | object | - |
| data.author.identifier | string | Identifier of the author. |
| data.author.type | string | Type of the author (user, api, job, system, ai-assistant or unknown-user-type). |
Example of payload
{
"specversion": "1.0",
"id": "018e32f9-dfe4-760e-a273-5da1c089dfdb",
"type": "com.akeneo.pim.v1.category.created",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-02-22T17:31:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.category.created.schema.json",
"data": {
"category": {
"code": "category-1"
},
"author": {
"identifier": "the-app-client-id",
"type": "api"
}
}
}
#com.akeneo.pim.v1.category.updated
This event is generated whenever an existing category is modified in the PIM.
- Message ID:
com.akeneo.pim.v1.category.updated - Content type: application/json
The event is triggered when any of the following properties are changed:
- The labels.
- The properties.
- The permissions.
- The values of enriched category attributes.
Note: The event is not triggered when a category is moved within a category tree.
#Payload
| Name | Type | Description |
|---|---|---|
| data.category | object | - |
| data.category.code | string | Unique identifier of a category |
| data.author | object | - |
| data.author.identifier | string | Identifier of the author. |
| data.author.type | string | Type of the author (user, api, job, system, ai-assistant or unknown-user-type). |
Example of payload
{
"specversion": "1.0",
"id": "018e32f9-dfe4-760e-a273-5da1c089dfdb",
"type": "com.akeneo.pim.v1.category.updated",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-02-22T17:31:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.category.updated.schema.json",
"data": {
"category": {
"code": "category-1"
},
"author": {
"identifier": "b238e9f7-fcec-45bd-9431-d43cd624b244",
"type": "user"
}
}
}
#com.akeneo.pim.v1.category.updated.delta
This event is generated whenever an existing category is modified in the PIM.
- Message ID:
com.akeneo.pim.v1.category.updated.delta - Content type: application/json
The following actions can trigger a category update delta event:
- Category update from the category page.
- Category update using the REST API.
The modifications that can lead to this event include:
- Changes to category properties, such as:
- Changes to the parent category
- Changes to the previous sibling within the category tree
- Changes to labels
- Changes to channel requirements
- Changes to validations
- Adjustments to enriched category attribute values
#Payload
| Name | Type | Description |
|---|---|---|
| data.category | object | - |
| data.category.code | string | Unique identifier of a category in the PIM. |
| data.category.changes | object | Details about the changes made to the category. |
| data.category.changes.parent | object | - |
| data.category.changes.parent.previous | string | null | - |
| data.category.changes.parent.new | string | null | - |
| data.category.changes.previous_sibling | object | The code of the sibling that precedes this category in the tree. |
| data.category.changes.previous_sibling.previous | string | null | - |
| data.category.changes.previous_sibling.new | string | null | - |
| data.category.changes.labels | object | - |
| data.category.changes.labels (additional properties) | object | - |
| data.category.changes.labels.previous | string | null | - |
| data.category.changes.labels.new | string | null | - |
| data.category.changes.channel_requirements | object | - |
| data.category.changes.channel_requirements.previous | array<string> | - |
| data.category.changes.channel_requirements.previous (single item) | string | - |
| data.category.changes.channel_requirements.new | array<string> | - |
| data.category.changes.channel_requirements.new (single item) | string | - |
| data.category.changes.validations | object | - |
| data.category.changes.validations (additional properties) | object | - |
| data.category.changes.validations.previous | string | number | boolean | object | array<any> | null | - |
| data.category.changes.validations.new | string | number | boolean | object | array<any> | null | - |
| data.category.changes.values | object | - |
| data.category.changes.values (additional properties) | array<object> | - |
| data.category.changes.values.previous | string | number | boolean | object | array<any> | null | - |
| data.category.changes.values.new | string | number | boolean | object | array<any> | null | - |
| data.category.changes.values.type | string | - |
| data.category.changes.values.locale | string | null | - |
| data.category.changes.values.scope | string | null | - |
| data.author | object | - |
| data.author.identifier | string | Identifier of the author. |
| data.author.type | string | Type of the author (user, api, job, system, ai-assistant or unknown-user-type). |
Example of payload
{
"specversion": "1.0",
"id": "018e32f9-dfe4-760e-a273-5da1c089dfdb",
"type": "com.akeneo.pim.v1.category.updated.delta",
"source": "pim",
"subject": "01948d3c-6625-7833-8a03-dd96245862d3",
"time": "2025-12-16T15:06:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.category.updated.delta.schema.json",
"data": {
"category": {
"code": "category-1",
"changes": {
"parent": {
"previous": "the_previous_parent_code",
"new": "the_new_parent_code"
},
"previous_sibling": {
"previous": "the_previous_sibling_code",
"new": "the_new_sibling_code"
},
"labels": {
"de_DE": {
"previous": "previous_de_DE",
"new": "new_de_DE"
},
"en_US": {
"previous": "previous_en_US",
"new": "new_en_US"
},
"fr_FR": {
"previous": "previous_fr_FR",
"new": "new_fr_FR"
}
},
"channel_requirements": {
"previous": [
"ecommerce"
],
"new": [
"ecommerce",
"print"
]
},
"validations": {
"max_categories_per_product": {
"previous": 42,
"new": 43
},
"only_leaves": {
"previous": true,
"new": false
},
"is_mandatory": {
"previous": false,
"new": true
}
},
"values": {
"an_added_attribute": [
{
"previous": null,
"new": "new_data",
"type": "a_type",
"locale": "a_locale",
"scope": "a_scope"
}
],
"an_updated_attribute": [
{
"previous": "previous_data",
"new": "new_data",
"type": "a_type",
"locale": "a_locale",
"scope": "a_scope"
}
],
"a_removed_attribute": [
{
"previous": "previous_data",
"new": null,
"type": "a_type",
"locale": "a_locale",
"scope": "a_scope"
}
],
"an_updated_attribute_with_different_value_by_locale": [
{
"previous": "previous_data",
"new": "new_data",
"type": "a_type",
"locale": "a_locale",
"scope": "a_scope"
},
{
"previous": "previous_data",
"new": "new_data",
"type": "a_type",
"locale": "another_locale",
"scope": "a_scope"
}
],
"an_updated_image_attribute": [
{
"previous": {
"size": 1024,
"extension": "png",
"file_path": "old/path/image.png",
"mime_type": "image/png",
"original_filename": "old-image.png"
},
"new": {
"size": 2048,
"extension": "jpg",
"file_path": "new/path/image.jpg",
"mime_type": "image/jpeg",
"original_filename": "new-image.jpg"
},
"type": "image",
"locale": "a_locale",
"scope": "a_scope"
}
],
"an_updated_text_attribute": [
{
"previous": "previous_data",
"new": "new_data",
"type": "text",
"locale": "a_locale",
"scope": "a_scope"
}
],
"an_updated_textarea_attribute": [
{
"previous": "previous_data",
"new": "new_data",
"type": "textarea",
"locale": "a_locale",
"scope": "a_scope"
}
],
"an_updated_datetime_attribute": [
{
"previous": "2026-01-13T12:49:00+00:00",
"new": "2026-02-14T12:49:00+00:00",
"type": "datetime",
"locale": "a_locale",
"scope": "a_scope"
}
],
"an_updated_boolean_attribute": [
{
"previous": true,
"new": false,
"type": "boolean",
"locale": "a_locale",
"scope": "a_scope"
}
],
"an_updated_simple_select_attribute": [
{
"previous": "previous_option",
"new": "new_option",
"type": "simple_select",
"locale": "a_locale",
"scope": "a_scope"
}
],
"an_updated_multi_select_attribute": [
{
"previous": [
"previous_option_1",
"previous_option_2"
],
"new": [
"new_option_1",
"new_option_2"
],
"type": "multi_select",
"locale": "a_locale",
"scope": "a_scope"
}
],
"an_updated_asset_collection_attribute": [
{
"previous": [
"previous_asset_collection_1",
"previous_asset_collection_2"
],
"new": [
"new_asset_collection_1",
"new_asset_collection_2"
],
"type": "asset_collection",
"locale": "a_locale",
"scope": "a_scope"
}
],
"an_updated_product_and_product_model_sort_attribute": [
{
"previous": [
{
"identifier": "44525abf-b9a0-4b8c-ab3d-b0807e7a0f85",
"type": "product"
},
{
"identifier": "44525abf-b9a0-4b8c-ab3d-b0807e7a0f86",
"type": "product"
},
{
"identifier": "previous_product_model_code_1",
"type": "product_model"
},
{
"identifier": "previous_product_model_code_2",
"type": "product_model"
}
],
"new": [
{
"identifier": "44525abf-b9a0-4b8c-ab3d-b0807e7a0f87",
"type": "product"
},
{
"identifier": "44525abf-b9a0-4b8c-ab3d-b0807e7a0f88",
"type": "product"
},
{
"identifier": "new_product_model_code_1",
"type": "product_model"
},
{
"identifier": "new_product_model_code_2",
"type": "product_model"
}
],
"type": "product_and_product_model_sort",
"locale": "a_locale",
"scope": "a_scope"
}
]
}
}
},
"author": {
"identifier": "b238e9f7-fcec-45bd-9431-d43cd624b244",
"type": "user"
}
}
}
#com.akeneo.pim.v1.category.deleted
This event is generated whenever a category is deleted from the PIM.
- Message ID:
com.akeneo.pim.v1.category.deleted - Content type: application/json
#Payload
| Name | Type | Description |
|---|---|---|
| data.category | object | - |
| data.category.code | string | Unique identifier of a category |
| data.author | object | - |
| data.author.identifier | string | Identifier of the author. |
| data.author.type | string | Type of the author (user, api, job, system, ai-assistant or unknown-user-type). |
Example of payload
{
"specversion": "1.0",
"id": "018e32f9-dfe4-760e-a273-5da1c089dfdb",
"type": "com.akeneo.pim.v1.category.deleted",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-02-22T17:31:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.category.deleted.schema.json",
"data": {
"category": {
"code": "category-1"
},
"author": {
"identifier": "the-app-client-id",
"type": "api"
}
}
}
#com.akeneo.pim.v1.connection.deleted
This event is generated whenever a connection is deleted from the PIM.
- Message ID:
com.akeneo.pim.v1.connection.deleted - Content type: application/json
#Payload
| Name | Type | Description |
|---|---|---|
| data.connection | object | - |
| data.connection.client_id | string | Unique identifier of a connection in the PIM. |
| data.author | object | - |
| data.author.identifier | string | Identifier of the author. |
| data.author.type | string | Type of the author (user, api, job, system, ai-assistant or unknown-user-type). |
Example of payload
{
"specversion": "1.0",
"id": "018e32f9-dfe4-760e-a273-5da1c089dfdb",
"type": "com.akeneo.pim.v1.connection.deleted",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-02-22T17:31:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.connection.deleted.schema.json",
"data": {
"connection": {
"client_id": "connection-client-id"
},
"author": {
"identifier": "the-connection-code",
"type": "api"
}
}
}
#com.akeneo.pim.v1.product.created
This event is generated whenever a new product is created in the PIM.
- Message ID:
com.akeneo.pim.v1.product.created - Content type: application/json
The following actions can trigger a product creation event:
- Product creation from the product page.
- Product creation using the REST API.
- Product creation within the rules engine.
- Product creation within workflows.
- Product creation via a tailored import.
#Payload
| Name | Type | Description |
|---|---|---|
| data.product | object | - |
| data.product.uuid | string | Unique identifier of a Product in the PIM. |
| data.product.identifier | string | null | Main product identifier (optional). Only included when the subscription has send_product_identifier enabled. |
| data.author | object | - |
| data.author.identifier | string | Identifier of the author. |
| data.author.type | string | Type of the author (user, api, job, system, ai-assistant or unknown-user-type). |
Example of payload
{
"specversion": "1.0",
"id": "018e32f9-dfe4-760e-a273-5da1c089dfdb",
"type": "com.akeneo.pim.v1.product.created",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-02-22T17:31:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.product.created.schema.json",
"data": {
"product": {
"uuid": "6a9f8486-2c36-4680-b87f-6f5f8f01b6cf",
"identifier": "my-product-sku"
},
"author": {
"identifier": "julia",
"type": "user"
}
}
}
#com.akeneo.pim.v1.product.updated
This event is generated whenever an existing product is modified in the PIM.
- Message ID:
com.akeneo.pim.v1.product.updated - Content type: application/json
The following actions can trigger a product update event:
- Product update from the product page.
- Product update using the REST API.
- Product update within the rules engine.
- Product update within workflows.
- Product update via a tailored import.
The modifications that can lead to this event include:
- Changes to product properties, such as:
- Family
- Parent
- Enabled status
- Changes in category association, such as:
- Adding the product to a category
- Removing the product from a category
- Changes in group association, such as:
- Adding the product to a group
- Removing the product from a group
- Adjustments to product values, including:
- Asset Collections
- Alterations to product associations, including:
- Standard associations
- Quantified associations
#Payload
| Name | Type | Description |
|---|---|---|
| data.product | object | - |
| data.product.uuid | string | Unique identifier of a Product in the PIM. |
| data.product.identifier | string | null | Main product identifier (optional). Only included when the subscription has send_product_identifier enabled. |
| data.author | object | - |
| data.author.identifier | string | Identifier of the author. |
| data.author.type | string | Type of the author (user, api, job, system, ai-assistant or unknown-user-type). |
Example of payload
{
"specversion": "1.0",
"id": "018e32f9-dfe4-760e-a273-5da1c089dfdb",
"type": "com.akeneo.pim.v1.product.updated",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-02-22T17:31:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.product.updated.schema.json",
"data": {
"product": {
"uuid": "6a9f8486-2c36-4680-b87f-6f5f8f01b6cf",
"identifier": "my-product-sku"
},
"author": {
"identifier": "admin",
"type": "user"
}
}
}
#com.akeneo.pim.v1.product.updated.delta
This event is generated whenever an existing product is modified in the PIM.
- Message ID:
com.akeneo.pim.v1.product.updated.delta - Content type: application/json
The following actions can trigger a product update event:
- Product update from the product page.
- Product update using the REST API.
- Product update within the rules engine.
- Product update within workflows.
- Product update via a tailored import.
The modifications that can lead to this event include:
- Changes to product properties, such as:
- Family
- Parent
- Enabled status
- Changes in category association, such as:
- Adding the product to a category
- Removing the product from a category
- Changes in group association, such as:
- Adding the product to a group
- Removing the product from a group
- Adjustments to product values, including:
- Asset Collections
- Alterations to product associations, including:
- Standard associations
- Quantified associations
#Payload
| Name | Type | Description |
|---|---|---|
| data.product | object | - |
| data.product.uuid | string | Unique identifier of a Product in the PIM. |
| data.product.identifier | string | null | Main product identifier (optional). Only included when the subscription has send_product_identifier enabled. |
| data.product.updated_at | any | - |
| data.product.changes | object | Details about the changes made to the product. |
| data.product.changes.enabled | object | - |
| data.product.changes.enabled.previous | boolean | - |
| data.product.changes.enabled.new | boolean | - |
| data.product.changes.categories | object | - |
| data.product.changes.categories.added | array<string> | - |
| data.product.changes.categories.added (single item) | string | - |
| data.product.changes.categories.removed | array<string> | - |
| data.product.changes.categories.removed (single item) | string | - |
| data.product.changes.family | object | - |
| data.product.changes.family.previous | string | null | - |
| data.product.changes.family.new | string | null | - |
| data.product.changes.groups | object | - |
| data.product.changes.groups.added | array<string> | - |
| data.product.changes.groups.added (single item) | string | - |
| data.product.changes.groups.removed | array<string> | - |
| data.product.changes.groups.removed (single item) | string | - |
| data.product.changes.parent | object | - |
| data.product.changes.parent.previous | string | null | - |
| data.product.changes.parent.new | string | null | - |
| data.product.changes.associations | object | - |
| data.product.changes.associations (additional properties) | object | - |
| data.product.changes.associations.added | object | - |
| data.product.changes.associations.added.products | array<oneOf> | - |
| data.product.changes.associations.added.products (single item) | oneOf | - |
| data.product.changes.associations.added.products.0 (oneOf item) | string | Product UUID. Default shape when the subscription option send_product_identifier_in_changes is disabled. |
| data.product.changes.associations.added.products.1 (oneOf item) | object | Product UUID with its main identifier. Shape used when the subscription option send_product_identifier_in_changes is enabled. |
| data.product.changes.associations.added.products.1.uuid | string | - |
| data.product.changes.associations.added.products.1.identifier | string | null | Main product identifier, null when the product has none. |
| data.product.changes.associations.added.product_models | array<string> | - |
| data.product.changes.associations.added.product_models (single item) | string | - |
| data.product.changes.associations.removed | object | - |
| data.product.changes.associations.removed.products | array<oneOf> | - |
| data.product.changes.associations.removed.products (single item) | oneOf | - |
| data.product.changes.associations.removed.products.0 (oneOf item) | string | Product UUID. Default shape when the subscription option send_product_identifier_in_changes is disabled. |
| data.product.changes.associations.removed.products.1 (oneOf item) | object | Product UUID with its main identifier. Shape used when the subscription option send_product_identifier_in_changes is enabled. |
| data.product.changes.associations.removed.products.1.uuid | string | - |
| data.product.changes.associations.removed.products.1.identifier | string | null | Main product identifier, null when the product has none. |
| data.product.changes.associations.removed.product_models | array<string> | - |
| data.product.changes.associations.removed.product_models (single item) | string | - |
| data.product.changes.quantified_associations | object | - |
| data.product.changes.quantified_associations (additional properties) | object | - |
| data.product.changes.quantified_associations.updated | object | - |
| data.product.changes.quantified_associations.updated.products | array<object> | - |
| data.product.changes.quantified_associations.updated.products.uuid | string | - |
| data.product.changes.quantified_associations.updated.products.quantity | number | - |
| data.product.changes.quantified_associations.updated.products.previous_quantity | number | - |
| data.product.changes.quantified_associations.updated.products.identifier | string | null | Main product identifier. Only present when the subscription option send_product_identifier_in_changes is enabled, null when the product has none. |
| data.product.changes.quantified_associations.updated.product_models | array<object> | - |
| data.product.changes.quantified_associations.updated.product_models.code | string | - |
| data.product.changes.quantified_associations.updated.product_models.quantity | number | - |
| data.product.changes.quantified_associations.updated.product_models.previous_quantity | number | - |
| data.product.changes.quantified_associations.added | object | - |
| data.product.changes.quantified_associations.added.products | array<object> | - |
| data.product.changes.quantified_associations.added.products.uuid | string | - |
| data.product.changes.quantified_associations.added.products.quantity | number | - |
| data.product.changes.quantified_associations.added.products.identifier | string | null | Main product identifier. Only present when the subscription option send_product_identifier_in_changes is enabled, null when the product has none. |
| data.product.changes.quantified_associations.added.product_models | array<object> | - |
| data.product.changes.quantified_associations.added.product_models.code | string | - |
| data.product.changes.quantified_associations.added.product_models.quantity | number | - |
| data.product.changes.quantified_associations.removed | object | - |
| data.product.changes.quantified_associations.removed.products | array<oneOf> | - |
| data.product.changes.quantified_associations.removed.products (single item) | oneOf | - |
| data.product.changes.quantified_associations.removed.products.0 (oneOf item) | string | Product UUID. Default shape when the subscription option send_product_identifier_in_changes is disabled. |
| data.product.changes.quantified_associations.removed.products.1 (oneOf item) | object | Product UUID with its main identifier. Shape used when the subscription option send_product_identifier_in_changes is enabled. |
| data.product.changes.quantified_associations.removed.products.1.uuid | string | - |
| data.product.changes.quantified_associations.removed.products.1.identifier | string | null | Main product identifier, null when the product has none. |
| data.product.changes.quantified_associations.removed.product_models | array<string> | - |
| data.product.changes.quantified_associations.removed.product_models (single item) | string | - |
| data.product.changes.values | object | - |
| data.product.changes.values (additional properties) | array<object> | - |
| data.product.changes.values.previous | string | number | boolean | object | array<any> | null | Value before the change. Depends on the attribute type. A product link to a product is an object {"type": "product", "id": "<product uuid>"}, with an extra identifier (main product identifier, nullable) when the subscription option send_product_identifier_in_changes is enabled. The same applies to product links inside table cells. |
| data.product.changes.values.new | string | number | boolean | object | array<any> | null | Value after the change. Depends on the attribute type. A product link to a product is an object {"type": "product", "id": "<product uuid>"}, with an extra identifier (main product identifier, nullable) when the subscription option send_product_identifier_in_changes is enabled. The same applies to product links inside table cells. |
| data.product.changes.values.type | string | - |
| data.product.changes.values.locale | string | null | - |
| data.product.changes.values.scope | string | null | - |
| data.product.changes.table_attributes | object | Changes to table attributes. |
| data.product.changes.table_attributes.added | array<object> | - |
| data.product.changes.table_attributes.added (single item) | object | - |
| data.product.changes.table_attributes.removed | array<object> | - |
| data.product.changes.table_attributes.removed (single item) | object | - |
| data.author | object | - |
| data.author.identifier | string | Identifier of the author. |
| data.author.type | string | Type of the author (user, api, job, system, ai-assistant or unknown-user-type). |
Example of payload
Default payload, subscription option send_product_identifier_in_changes disabled: products in the changes are referenced by UUID only.
{
"specversion": "1.0",
"id": "018e32f9-dfe4-760e-a273-5da1c089dfdb",
"type": "com.akeneo.pim.v1.product.updated.delta",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-02-22T17:31:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.product.updated.delta.schema.json",
"data": {
"product": {
"uuid": "6a9f8486-2c36-4680-b87f-6f5f8f01b6cf",
"identifier": "my-product-sku",
"updated_at": {
"date": "2024-10-14 13:01:21.000000",
"timezone": "UTC"
},
"changes": {
"enabled": {
"previous": true,
"new": false
},
"categories": {
"added": [
"added_category_code_1",
"added_category_code_2"
],
"removed": [
"removed_category_code_1",
"removed_category_code_2"
]
},
"family": {
"previous": "the_previous_family_code",
"new": "the_new_family_code"
},
"groups": {
"added": [
"added_group_code_1",
"added_group_code_2"
],
"removed": [
"removed_group_code_1",
"_removed_group_code_2"
]
},
"parent": {
"previous": "the_previous_parent_code",
"new": "the_new_parent_code"
},
"values": {
"an_added_attribute": [
{
"previous": null,
"new": "new_data",
"type": "an_attribute_type",
"locale": "a_locale",
"scope": "a_scope"
}
],
"an_updated_attribute": [
{
"previous": "previous_data",
"new": "new_data",
"type": "an_attribute_type",
"locale": "a_locale",
"scope": "a_scope"
}
],
"a_removed_attribute": [
{
"previous": "previous_data",
"new": null,
"type": "an_attribute_type",
"locale": "a_locale",
"scope": "a_scope"
}
],
"an_attribute_with_value_by_locale": [
{
"previous": "previous_data_for_a_locale",
"new": "new_data_for_a_locale",
"type": "an_attribute_type",
"locale": "a_locale",
"scope": "a_scope"
},
{
"previous": "previous_data_for_another_locale",
"new": "new_data_for_another_locale",
"type": "an_attribute_type",
"locale": "another_locale",
"scope": "a_scope"
}
],
"an_attribute_with_value_by_scope": [
{
"previous": "previous_data_for_a_scope",
"new": "new_data_for_a_scope",
"type": "an_attribute_type",
"locale": "a_locale",
"scope": "a_scope"
},
{
"previous": "previous_data_for_another_scope",
"new": "new_data_for_another_scope",
"type": "an_attribute_type",
"locale": "a_locale",
"scope": "another_scope"
}
],
"a_pim_catalog_text_attribute": [
{
"previous": "previous_data",
"new": "new_data",
"type": "pim_catalog_text",
"locale": "a_locale",
"scope": "a_scope"
}
],
"a_pim_catalog_textarea_attribute": [
{
"previous": "previous_data",
"new": "new_data",
"type": "pim_catalog_textarea",
"locale": "a_locale",
"scope": "a_scope"
}
],
"a_pim_catalog_file_attribute": [
{
"previous": {
"file_name": "old_file.json",
"key": "0/e/f/9/0ef94f3e2e8133df2d37dc1e9c88615629707ede_old_file.json"
},
"new": {
"file_name": "new_file.json",
"key": "0/e/f/9/0ef94f3e2e8133df2d37dc1e9c88615629707ede_new_file.json"
},
"type": "pim_catalog_file",
"locale": "a_locale",
"scope": "a_scope"
}
],
"a_pim_catalog_image_attribute": [
{
"previous": {
"file_name": "old_pic.jpg",
"key": "0/e/f/9/0ef94f3e2e8133df2d37dc1e9c88615629707ede_old_pic.jpg"
},
"new": {
"file_name": "new_pic.jpg",
"key": "0/e/f/9/0ef94f3e2e8133df2d37dc1e9c88615629707ede_new_pic.jpg"
},
"type": "pim_catalog_image",
"locale": "a_locale",
"scope": "a_scope"
}
],
"a_pim_catalog_product_link_attribute": [
{
"previous": {
"type": "product",
"id": "83413cad-b3aa-4f68-9b4b-7fc90c1ce84a"
},
"new": {
"type": "product",
"id": "aeabe737-f655-4389-bcc0-d8dd2fc47824"
},
"type": "pim_catalog_product_link",
"locale": "a_locale",
"scope": "a_scope"
}
],
"a_pim_catalog_number_attribute": [
{
"previous": 0,
"new": 2,
"type": "pim_catalog_number",
"locale": "a_locale",
"scope": "a_scope"
}
],
"a_pim_catalog_metric_attribute": [
{
"previous": {
"data": "previous_data",
"unit": "a_unit",
"base_data": "previous_based_data",
"base_unit": "a_based_unit",
"family": "a_family"
},
"new": {
"data": "new_data",
"unit": "a_unit",
"base_data": "new_based_data",
"base_unit": "a_based_unit"
},
"type": "pim_catalog_metric",
"locale": "a_locale",
"scope": "a_scope",
"family": "a_family"
}
],
"a_pim_catalog_price_attribute": [
{
"previous": {
"amount": "a_price",
"currency": "a_currency"
},
"new": {
"amount": "another_price",
"currency": "a_currency"
},
"type": "pim_catalog_price",
"locale": "a_locale",
"scope": "a_scope"
}
],
"a_pim_catalog_boolean_attribute": [
{
"previous": true,
"new": false,
"type": "pim_catalog_boolean",
"locale": "a_locale",
"scope": "a_scope"
}
],
"a_pim_catalog_date_attribute": [
{
"previous": "2024-01-01T00:00:00+00:00",
"new": "2024-01-02T00:00:00+00:00",
"type": "pim_catalog_date",
"locale": "a_locale",
"scope": "a_scope"
}
],
"an_identifier_attribute": [
{
"previous": {
"data": "previous_data",
"is_main_identifier": false
},
"new": {
"data": "new_data",
"is_main_identifier": true
},
"type": "pim_catalog_identifier",
"locale": "a_locale",
"scope": "a_scope"
}
],
"a_simple_select_attribute": [
{
"previous": "previous_data",
"new": "new_data",
"type": "pim_catalog_simpleselect",
"locale": "a_locale",
"scope": "a_scope"
}
],
"a_multi_select_attribute": [
{
"previous": [
"value_1",
"value_2"
],
"new": [
"value_1",
"value_3"
],
"type": "pim_catalog_multiselect",
"locale": "a_locale",
"scope": "a_scope"
}
],
"a_pim_catalog_table_attribute": [
{
"previous": {
"rows": [
{
"cells": [
{
"cell": "cell_1_of_row_1",
"data": "data_of_cell_1_of_row_1"
},
{
"cell": "cell_2_of_row_1",
"data": "data_of_cell_2_of_row_1"
}
]
},
{
"cells": [
{
"cell": "cell_1_of_row_2",
"data": "data_of_cell_1_of_row_2"
},
{
"cell": "cell_2_of_row_2",
"data": "data_of_cell_2_of_row_2"
}
]
}
]
},
"new": {
"rows": [
{
"cells": [
{
"cell": "cell_1_of_row_1",
"data": "data_of_cell_1_of_row_1"
},
{
"cell": "cell_2_of_row_1",
"data": "data_of_cell_2_of_row_1"
}
]
},
{
"cells": [
{
"cell": "cell_1_of_row_2",
"data": "data_of_cell_1_of_row_2"
},
{
"cell": "cell_2_of_row_2",
"data": "data_of_cell_2_of_row_2"
}
]
},
{
"cells": [
{
"cell": "cell_1_of_row_3",
"data": "data_of_cell_1_of_row_3"
},
{
"cell": "cell_2_of_row_3",
"data": "data_of_cell_2_of_row_3"
}
]
}
]
},
"type": "pim_catalog_table",
"locale": "a_locale",
"scope": "a_scope"
}
],
"an_asset_collection_attribute": [
{
"previous": [
"asset_code_1",
"asset_code_2"
],
"new": [
"asset_code_1",
"asset_code_3"
],
"type": "pim_catalog_asset_collection",
"locale": "a_locale",
"scope": "a_scope"
}
],
"an_akeneo_reference_entity_attribute": [
{
"previous": "previous_reference_entity_code",
"new": "new_reference_entity_code",
"type": "akeneo_reference_entity",
"locale": "a_locale",
"scope": "a_scope"
}
],
"an_akeneo_reference_entity_collection_attribute": [
{
"previous": [
"reference_entity_record_code_1",
"reference_entity_record_code_2"
],
"new": [
"reference_entity_record_code_1",
"reference_entity_record_code_3"
],
"type": "akeneo_reference_entity_collection",
"locale": "a_locale",
"scope": "a_scope"
}
]
},
"associations": {
"an_association_type_code": {
"added": {
"products": [
"a_product_uuid_1",
"a_product_uuid_2"
],
"product_models": [
"a_product_model_1",
"a_product_model_2"
],
"groups": [
"an_association_group_1",
"an_association_group_2"
]
},
"removed": {
"products": [
"a_product_uuid_1",
"a_product_uuid_2"
],
"product_models": [
"a_product_model_1",
"a_product_model_2"
],
"groups": [
"an_association_group_1",
"an_association_group_2"
]
}
},
"another_association_type_code": {
"added": {
"products": [
"a_product_uuid_1",
"a_product_uuid_2"
],
"product_models": [
"a_product_model_1",
"a_product_model_2"
],
"groups": [
"an_association_group_1",
"an_association_group_2"
]
},
"removed": {
"products": [
"a_product_uuid_1",
"a_product_uuid_2"
],
"product_models": [
"a_product_model_1",
"a_product_model_2"
],
"groups": [
"an_association_group_1",
"an_association_group_2"
]
}
}
},
"quantified_associations": {
"an_association_type_code": {
"added": {
"products": [
{
"uuid": "an_added_product_uuid",
"quantity": 1
},
{
"uuid": "another_added_product_uuid",
"quantity": 2
}
],
"product_models": [
{
"code": "an_added_product_model_code",
"quantity": 3
},
{
"code": "another_added_product_model_code",
"quantity": 4
}
]
},
"updated": {
"products": [
{
"uuid": "an_updated_product_uuid",
"quantity": 5,
"previous_quantity": 3
}
],
"product_models": [
{
"code": "an_updated_product_model_code",
"quantity": 6,
"previous_quantity": 2
}
]
},
"removed": {
"products": [
"a_product_uuid_1",
"a_product_uuid_2"
],
"product_models": [
"a_product_model_code",
"another_product_model_code"
]
}
},
"another_association_type_code": {
"added": {
"products": [
{
"uuid": "an_added_product_uuid",
"quantity": 1
},
{
"uuid": "another_added_product_uuid",
"quantity": 2
}
],
"product_models": [
{
"code": "an_added_product_model_code",
"quantity": 3
},
{
"code": "another_added_product_model_code",
"quantity": 4
}
]
},
"updated": {
"products": [
{
"uuid": "an_updated_product_uuid",
"quantity": 5,
"previous_quantity": 3
}
],
"product_models": [
{
"code": "an_updated_product_model_code",
"quantity": 6,
"previous_quantity": 2
}
]
},
"removed": {
"products": [
"a_product_uuid_1",
"a_product_uuid_2"
],
"product_models": [
"a_product_model_code",
"another_product_model_code"
]
}
}
}
}
},
"author": {
"identifier": "julia",
"type": "user"
}
}
}
Payload when the subscription option send_product_identifier_in_changes is enabled: products in the changes carry their main identifier.
{
"specversion": "1.0",
"id": "018e32f9-dfe4-760e-a273-5da1c089dfdc",
"type": "com.akeneo.pim.v1.product.updated.delta",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-02-22T17:31:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.product.updated.delta.schema.json",
"data": {
"product": {
"uuid": "6a9f8486-2c36-4680-b87f-6f5f8f01b6cf",
"identifier": "my-product-sku",
"updated_at": {
"date": "2024-10-14 13:01:21.000000",
"timezone": "UTC"
},
"changes": {
"values": {
"a_pim_catalog_product_link_attribute": [
{
"previous": {
"type": "product",
"id": "83413cad-b3aa-4f68-9b4b-7fc90c1ce84a",
"identifier": "a_previous_product_identifier"
},
"new": {
"type": "product",
"id": "aeabe737-f655-4389-bcc0-d8dd2fc47824",
"identifier": "a_new_product_identifier"
},
"type": "pim_catalog_product_link",
"locale": "a_locale",
"scope": "a_scope"
}
]
},
"associations": {
"an_association_type_code": {
"added": {
"products": [
{
"uuid": "a_product_uuid_1",
"identifier": "a_product_identifier_1"
},
{
"uuid": "a_product_uuid_2",
"identifier": "a_product_identifier_2"
}
],
"product_models": [
"a_product_model_1"
],
"groups": [
"an_association_group_1"
]
},
"removed": {
"products": [
{
"uuid": "a_product_uuid_3",
"identifier": "a_product_identifier_3"
},
{
"uuid": "a_product_uuid_4",
"identifier": null
}
],
"product_models": [
"a_product_model_2"
],
"groups": [
"an_association_group_2"
]
}
}
},
"quantified_associations": {
"a_quantified_association_type_code": {
"added": {
"products": [
{
"uuid": "an_added_product_uuid",
"identifier": "an_added_product_identifier",
"quantity": 1
}
],
"product_models": [
{
"code": "an_added_product_model_code",
"quantity": 3
}
]
},
"updated": {
"products": [
{
"uuid": "an_updated_product_uuid",
"identifier": "an_updated_product_identifier",
"quantity": 5,
"previous_quantity": 3
}
],
"product_models": [
{
"code": "an_updated_product_model_code",
"quantity": 6,
"previous_quantity": 2
}
]
},
"removed": {
"products": [
{
"uuid": "a_removed_product_uuid",
"identifier": "a_removed_product_identifier"
}
],
"product_models": [
"a_removed_product_model_code"
]
}
}
}
}
}
}
}
#com.akeneo.pim.v1.product.deleted
This event is generated whenever a product is deleted from the PIM.
- Message ID:
com.akeneo.pim.v1.product.deleted - Content type: application/json
The following actions can trigger a product deletion event:
- Product deletion from the product page.
- Product deletion using the REST API.
- Product deletion within the rules engine.
- Product deletion within workflows.
- Product deletion via a tailored import.
#Payload
| Name | Type | Description |
|---|---|---|
| data.product | object | - |
| data.product.uuid | string | Unique identifier of a Product in the PIM. |
| data.product.identifier | string | null | Main product identifier (optional). Only included when the subscription has send_product_identifier enabled. |
| data.author | object | - |
| data.author.identifier | string | Identifier of the author. |
| data.author.type | string | Type of the author (user, api, job, system, ai-assistant or unknown-user-type). |
Example of payload
{
"specversion": "1.0",
"id": "018e32f9-dfe4-760e-a273-5da1c089dfdb",
"type": "com.akeneo.pim.v1.product.deleted",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-02-22T17:31:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.product.deleted.schema.json",
"data": {
"product": {
"uuid": "6a9f8486-2c36-4680-b87f-6f5f8f01b6cf",
"identifier": "my-product-sku"
},
"author": {
"identifier": "b238e9f7-fcec-45bd-9431-d43cd624b244",
"type": "user"
}
}
}
#com.akeneo.pim.v1.product.became-complete
This event is generated whenever a product became complete on at least one combination of locale and scope.
- Message ID:
com.akeneo.pim.v1.product.became-complete - Content type: application/json
The following actions can trigger a product completed event:
- Product creation or update from the product page.
- Product creation or update using the REST API.
- Product creation or update within the rules engine.
- Product creation or update within workflows.
- Product creation or update via a tailored import.
- Product model update from the product page.
- Product model update using the REST API.
- Product model update within the rules engine.
- Product model update within workflows.
#Payload
| Name | Type | Description |
|---|---|---|
| data.product | object | - |
| data.product.uuid | string | Unique identifier of a Product in the PIM. |
| data.product.identifier | string | null | Main product identifier (optional). Only included when the subscription has send_product_identifier enabled. |
| data.product.complete_on | array<object> | New combinations of locale and scope codes where the product became complete. |
| data.product.complete_on.locale | string | Locale code for the completion. |
| data.product.complete_on.scope | string | Scope code for the completion. |
Example of payload
{
"specversion": "1.0",
"id": "018e32f9-dfe4-760e-a273-5da1c089dfdb",
"type": "com.akeneo.pim.v1.product.became-complete",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-02-22T17:31:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.product.became-complete.schema.json",
"data": {
"product": {
"uuid": "6a9f8486-2c36-4680-b87f-6f5f8f01b6cf",
"identifier": "an_identifier",
"complete_on": [
{
"locale": "en_US",
"scope": "ecommerce"
},
{
"locale": "fr_FR",
"scope": "mobile"
}
]
}
}
}
#com.akeneo.pim.v1.product.became-incomplete
This event is generated whenever a product became incomplete on at least one combination of locale and scope.
- Message ID:
com.akeneo.pim.v1.product.became-incomplete - Content type: application/json
The following actions can trigger a product became incomplete event:
- Product update from the product page.
- Product update using the REST API.
- Product update within the rules engine.
- Product update within workflows.
- Product update via a tailored import.
- Product model update from the product page.
- Product model update using the REST API.
- Product model update within the rules engine.
- Product model update within workflows.
#Payload
| Name | Type | Description |
|---|---|---|
| data.product | object | - |
| data.product.uuid | string | Unique identifier of a Product in the PIM. |
| data.product.identifier | string | null | Main product identifier (optional). Only included when the subscription has send_product_identifier enabled. |
| data.product.incomplete_on | array<object> | Combinations of locale and scope codes where the product became incomplete. |
| data.product.incomplete_on.locale | string | Locale code for the completion. |
| data.product.incomplete_on.scope | string | Scope code for the completion. |
Example of payload
{
"specversion": "1.0",
"id": "018e32f9-dfe4-760e-a273-5da1c089dfdb",
"type": "com.akeneo.pim.v1.product.became-incomplete",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-02-22T17:31:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.product.became-incomplete.schema.json",
"data": {
"product": {
"uuid": "6a9f8486-2c36-4680-b87f-6f5f8f01b6cf",
"identifier": "an_identifier",
"incomplete_on": [
{
"locale": "en_US",
"scope": "ecommerce"
},
{
"locale": "fr_FR",
"scope": "mobile"
}
]
}
}
}
#com.akeneo.pim.v1.product.became-ready
This event is generated whenever a product reaches a 100% readiness score on at least one combination of locale and scope.
- Message ID:
com.akeneo.pim.v1.product.became-ready - Content type: application/json
This event is currently in a managed rollout phase and is available to a limited group of customers. If you would like to request early access, please reach out to your Customer Success Manager.
The following actions can trigger a product became ready event:
- Product creation or update from the product page.
- Product creation or update using the REST API.
- Product creation or update within the rules engine.
- Product creation or update within workflows.
- Product creation or update via a tailored import.
The event is emitted only when the readiness score transitions from below 100% to 100% on a (locale, scope) combination for a given readiness.
#Payload
| Name | Type | Description |
|---|---|---|
| data.product | object | - |
| data.product.uuid | string | Unique identifier of a Product in the PIM. |
| data.product.identifier | string | null | Main product identifier (optional). Only included when the subscription has send_product_identifier enabled. |
| data.product.ready_on | object | Combinations of locale and scope codes where the product newly reached 100% readiness, grouped by readiness code. Combinations that were already at 100% are not listed. |
| data.product.ready_on (additional properties) | array<object> | - |
| data.product.ready_on.locale | string | Locale code where the readiness reached 100%. |
| data.product.ready_on.scope | string | Scope code where the readiness reached 100%. |
| data.product.ready_on_scopes | array<string> | Scope (channel) codes on which the product newly became ready. A product is ready for a scope (channel) when its readiness score is 100% for all locales and all readiness configurations that involve this product. Scopes that were already ready are not listed. |
| data.product.ready_on_scopes (single item) | string | - |
Example of payload
{
"specversion": "1.0",
"id": "018e32f9-dfe4-760e-a273-5da1c089dfdb",
"type": "com.akeneo.pim.v1.product.became-ready",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-02-22T17:31:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.product.became-ready.schema.json",
"data": {
"product": {
"uuid": "6a9f8486-2c36-4680-b87f-6f5f8f01b6cf",
"identifier": "an_identifier",
"ready_on": {
"a_readiness_code_1": [
{
"locale": "en_US",
"scope": "ecommerce"
},
{
"locale": "fr_FR",
"scope": "mobile"
}
],
"a_readiness_code_2": [
{
"locale": "en_US",
"scope": "ecommerce"
}
]
},
"ready_on_scopes": [
"ecommerce",
"mobile"
]
}
}
}
#com.akeneo.pim.v1.product.became-not-ready
This event is generated whenever a product readiness score drops below 100% on at least one combination of locale and scope.
- Message ID:
com.akeneo.pim.v1.product.became-not-ready - Content type: application/json
This event is currently in a managed rollout phase and is available to a limited group of customers. If you would like to request early access, please reach out to your Customer Success Manager.
The following actions can trigger a product became not ready event:
- Product creation or update from the product page.
- Product creation or update using the REST API.
- Product creation or update within the rules engine.
- Product creation or update within workflows.
- Product creation or update via a tailored import.
The event is emitted only when the readiness score transitions from 100% to below 100% on a (locale, scope) combination for a given readiness.
#Payload
| Name | Type | Description |
|---|---|---|
| data.product | object | - |
| data.product.uuid | string | Unique identifier of a Product in the PIM. |
| data.product.identifier | string | null | Main product identifier (optional). Only included when the subscription has send_product_identifier enabled. |
| data.product.not_ready_on | object | Combinations of locale and scope codes where the product readiness newly dropped below 100%, grouped by readiness code. Combinations already below 100% are not listed. |
| data.product.not_ready_on (additional properties) | array<object> | - |
| data.product.not_ready_on.locale | string | Locale code where the readiness dropped below 100%. |
| data.product.not_ready_on.scope | string | Scope code where the readiness dropped below 100%. |
| data.product.not_ready_on_scopes | array<string> | Scope (channel) codes on which the product is newly no longer ready. A product is ready for a scope (channel) when its readiness score is 100% for all locales and all readiness configurations that involve this product. Scopes that were already not ready are not listed. |
| data.product.not_ready_on_scopes (single item) | string | - |
Example of payload
{
"specversion": "1.0",
"id": "018e32f9-dfe4-760e-a273-5da1c089dfdb",
"type": "com.akeneo.pim.v1.product.became-not-ready",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-02-22T17:31:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.product.became-not-ready.schema.json",
"data": {
"product": {
"uuid": "6a9f8486-2c36-4680-b87f-6f5f8f01b6cf",
"identifier": "an_identifier",
"not_ready_on": {
"a_readiness_code_1": [
{
"locale": "en_US",
"scope": "ecommerce"
},
{
"locale": "fr_FR",
"scope": "mobile"
}
],
"a_readiness_code_2": [
{
"locale": "en_US",
"scope": "ecommerce"
}
]
},
"not_ready_on_scopes": [
"ecommerce"
]
}
}
}
#com.akeneo.pim.v1.product-model.became-not-ready
This event is generated whenever a product model readiness score drops below 100% on at least one combination of locale and scope.
- Message ID:
com.akeneo.pim.v1.product-model.became-not-ready - Content type: application/json
This event is currently in a managed rollout phase and is available to a limited group of customers. If you would like to request early access, please reach out to your Customer Success Manager.
The following actions can trigger a product model became not ready event:
- Product model creation or update from the product model page.
- Product model creation or update using the REST API.
- Product model creation or update within the rules engine.
- Product model creation or update within workflows.
- Product model creation or update via a tailored import.
The event is emitted only when the readiness score transitions from 100% to below 100% on a (locale, scope) combination for a given readiness.
#Payload
| Name | Type | Description |
|---|---|---|
| data.product_model | object | - |
| data.product_model.code | string | Unique identifier of a Product Model in the PIM. |
| data.product_model.not_ready_on | object | Combinations of locale and scope codes where the product model readiness newly dropped below 100%, grouped by readiness code. Combinations already below 100% are not listed. |
| data.product_model.not_ready_on (additional properties) | array<object> | - |
| data.product_model.not_ready_on.locale | string | Locale code where the readiness dropped below 100%. |
| data.product_model.not_ready_on.scope | string | Scope code where the readiness dropped below 100%. |
| data.product_model.not_ready_on_scopes | array<string> | Scope (channel) codes on which the product model is newly no longer ready. A product model is ready for a scope (channel) when its readiness score is 100% for all locales and all readiness configurations that involve this product model. Scopes that were already not ready are not listed. |
| data.product_model.not_ready_on_scopes (single item) | string | - |
Example of payload
{
"specversion": "1.0",
"id": "018e32f9-dfe4-760e-a273-5da1c089dfdb",
"type": "com.akeneo.pim.v1.product-model.became-not-ready",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-02-22T17:31:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.product-model.became-not-ready.schema.json",
"data": {
"product_model": {
"code": "a-product-model-code",
"not_ready_on": {
"a_readiness_code_1": [
{
"locale": "en_US",
"scope": "ecommerce"
},
{
"locale": "fr_FR",
"scope": "mobile"
}
],
"a_readiness_code_2": [
{
"locale": "en_US",
"scope": "ecommerce"
}
]
},
"not_ready_on_scopes": [
"ecommerce"
]
}
}
}
#com.akeneo.pim.v1.product-model.became-ready
This event is generated whenever a product model reaches a 100% readiness score on at least one combination of locale and scope.
- Message ID:
com.akeneo.pim.v1.product-model.became-ready - Content type: application/json
This event is currently in a managed rollout phase and is available to a limited group of customers. If you would like to request early access, please reach out to your Customer Success Manager.
The following actions can trigger a product model became ready event:
- Product model creation or update from the product model page.
- Product model creation or update using the REST API.
- Product model creation or update within the rules engine.
- Product model creation or update within workflows.
- Product model creation or update via a tailored import.
The event is emitted only when the readiness score transitions from below 100% to 100% on a (locale, scope) combination for a given readiness.
#Payload
| Name | Type | Description |
|---|---|---|
| data.product_model | object | - |
| data.product_model.code | string | Unique identifier of a Product Model in the PIM. |
| data.product_model.ready_on | object | Combinations of locale and scope codes where the product model newly reached 100% readiness, grouped by readiness code. Combinations already at 100% are not listed. |
| data.product_model.ready_on (additional properties) | array<object> | - |
| data.product_model.ready_on.locale | string | Locale code where the readiness reached 100%. |
| data.product_model.ready_on.scope | string | Scope code where the readiness reached 100%. |
| data.product_model.ready_on_scopes | array<string> | Scope (channel) codes on which the product model newly became ready. A product model is ready for a scope (channel) when its readiness score is 100% for all locales and all readiness configurations that involve this product model. Scopes already ready are not listed. |
| data.product_model.ready_on_scopes (single item) | string | - |
Example of payload
{
"specversion": "1.0",
"id": "018e32f9-dfe4-760e-a273-5da1c089dfdb",
"type": "com.akeneo.pim.v1.product-model.became-ready",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-02-22T17:31:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.product-model.became-ready.schema.json",
"data": {
"product_model": {
"code": "a-product-model-code",
"ready_on": {
"a_readiness_code_1": [
{
"locale": "en_US",
"scope": "ecommerce"
},
{
"locale": "fr_FR",
"scope": "mobile"
}
],
"a_readiness_code_2": [
{
"locale": "en_US",
"scope": "ecommerce"
}
]
},
"ready_on_scopes": [
"ecommerce",
"mobile"
]
}
}
}
#com.akeneo.pim.v1.product-model.created
This event is generated whenever a new product model is created in the PIM.
- Message ID:
com.akeneo.pim.v1.product-model.created - Content type: application/json
#Payload
| Name | Type | Description |
|---|---|---|
| data.product_model | object | - |
| data.product_model.code | string | Unique identifier of a Product Model in the PIM. |
| data.author | object | - |
| data.author.identifier | string | Identifier of the author. |
| data.author.type | string | Type of the author (user, api, job, system, ai-assistant or unknown-user-type). |
Example of payload
{
"specversion": "1.0",
"id": "b6f4add4-f3d1-4502-8cf0-0f228e054ce5",
"type": "com.akeneo.pim.v1.product-model.created",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-06-10T17:31:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.product-model.created.schema.json",
"data": {
"product_model": {
"code": "a-product-model-code"
},
"author": {
"identifier": "b238e9f7-fcec-45bd-9431-d43cd624b244",
"type": "user"
}
}
}
#com.akeneo.pim.v1.product-model.updated
This event is generated whenever an existing product model is modified in the PIM.
- Message ID:
com.akeneo.pim.v1.product-model.updated - Content type: application/json
The modifications that can lead to this event include:
- Changes to the product model's parent property.
- Changes in category association, such as:
- Adding the product to a category
- Removing the product from a category
- Adjustments to product model values.
- Alterations to product model associations, including:
- Standard associations
- Quantified associations
#Payload
| Name | Type | Description |
|---|---|---|
| data.product_model | object | - |
| data.product_model.code | string | Unique identifier of a Product Model in the PIM. |
| data.author | object | - |
| data.author.identifier | string | Identifier of the author. |
| data.author.type | string | Type of the author (user, api, job, system, ai-assistant or unknown-user-type). |
Example of payload
{
"specversion": "1.0",
"id": "b6f4add4-f3d1-4502-8cf0-0f228e054ce5",
"type": "com.akeneo.pim.v1.product-model.updated",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-06-10T17:31:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.product-model.updated.schema.json",
"data": {
"product_model": {
"code": "a-product-model-code"
},
"author": {
"identifier": "b238e9f7-fcec-45bd-9431-d43cd624b244",
"type": "user"
}
}
}
#com.akeneo.pim.v1.product-model.updated.delta
This event is generated whenever an existing product model is modified in the PIM.
- Message ID:
com.akeneo.pim.v1.product-model.updated.delta - Content type: application/json
The following actions can trigger a product model update event:
- Product model update from the product page.
- Product model update using the REST API.
- Product model update within the rules engine.
- Product model update within workflows.
- Product model update via a tailored import.
The modifications that can lead to this event include:
- Changes to product model properties, such as:
- Changes in category association, such as:
- Adding the product model to a category
- Removing the product model from a category
- Changes in category association, such as:
- Changes in group association, such as:
- Adding the product model to a group
- Removing the product model from a group
- Adjustments to product model values
- Alterations to product model associations, including:
- Standard associations
- Quantified associations
#Payload
| Name | Type | Description |
|---|---|---|
| data.product_model | object | - |
| data.product_model.code | string | Unique identifier of a Product Model in the PIM. |
| data.product_model.updated_at | any | - |
| data.product_model.changes | object | Details about the changes made to the product model. |
| data.product_model.changes.categories | object | - |
| data.product_model.changes.categories.added | array<string> | - |
| data.product_model.changes.categories.added (single item) | string | - |
| data.product_model.changes.categories.removed | array<string> | - |
| data.product_model.changes.categories.removed (single item) | string | - |
| data.product_model.changes.parent | object | - |
| data.product_model.changes.parent.previous | string | null | - |
| data.product_model.changes.parent.new | string | null | - |
| data.product_model.changes.associations | object | - |
| data.product_model.changes.associations (additional properties) | object | - |
| data.product_model.changes.associations.added | object | - |
| data.product_model.changes.associations.added.products | array<oneOf> | - |
| data.product_model.changes.associations.added.products (single item) | oneOf | - |
| data.product_model.changes.associations.added.products.0 (oneOf item) | string | Product UUID. Default shape when the subscription option send_product_identifier_in_changes is disabled. |
| data.product_model.changes.associations.added.products.1 (oneOf item) | object | Product UUID with its main identifier. Shape used when the subscription option send_product_identifier_in_changes is enabled. |
| data.product_model.changes.associations.added.products.1.uuid | string | - |
| data.product_model.changes.associations.added.products.1.identifier | string | null | Main product identifier, null when the product has none. |
| data.product_model.changes.associations.added.product_models | array<string> | - |
| data.product_model.changes.associations.added.product_models (single item) | string | - |
| data.product_model.changes.associations.removed | object | - |
| data.product_model.changes.associations.removed.products | array<oneOf> | - |
| data.product_model.changes.associations.removed.products (single item) | oneOf | - |
| data.product_model.changes.associations.removed.products.0 (oneOf item) | string | Product UUID. Default shape when the subscription option send_product_identifier_in_changes is disabled. |
| data.product_model.changes.associations.removed.products.1 (oneOf item) | object | Product UUID with its main identifier. Shape used when the subscription option send_product_identifier_in_changes is enabled. |
| data.product_model.changes.associations.removed.products.1.uuid | string | - |
| data.product_model.changes.associations.removed.products.1.identifier | string | null | Main product identifier, null when the product has none. |
| data.product_model.changes.associations.removed.product_models | array<string> | - |
| data.product_model.changes.associations.removed.product_models (single item) | string | - |
| data.product_model.changes.quantified_associations | object | - |
| data.product_model.changes.quantified_associations (additional properties) | object | - |
| data.product_model.changes.quantified_associations.updated | object | - |
| data.product_model.changes.quantified_associations.updated.products | array<object> | - |
| data.product_model.changes.quantified_associations.updated.products.uuid | string | - |
| data.product_model.changes.quantified_associations.updated.products.quantity | number | - |
| data.product_model.changes.quantified_associations.updated.products.previous_quantity | number | - |
| data.product_model.changes.quantified_associations.updated.products.identifier | string | null | Main product identifier. Only present when the subscription option send_product_identifier_in_changes is enabled, null when the product has none. |
| data.product_model.changes.quantified_associations.updated.product_models | array<object> | - |
| data.product_model.changes.quantified_associations.updated.product_models.code | string | - |
| data.product_model.changes.quantified_associations.updated.product_models.quantity | number | - |
| data.product_model.changes.quantified_associations.updated.product_models.previous_quantity | number | - |
| data.product_model.changes.quantified_associations.added | object | - |
| data.product_model.changes.quantified_associations.added.products | array<object> | - |
| data.product_model.changes.quantified_associations.added.products.uuid | string | - |
| data.product_model.changes.quantified_associations.added.products.quantity | number | - |
| data.product_model.changes.quantified_associations.added.products.identifier | string | null | Main product identifier. Only present when the subscription option send_product_identifier_in_changes is enabled, null when the product has none. |
| data.product_model.changes.quantified_associations.added.product_models | array<object> | - |
| data.product_model.changes.quantified_associations.added.product_models.code | string | - |
| data.product_model.changes.quantified_associations.added.product_models.quantity | number | - |
| data.product_model.changes.quantified_associations.removed | object | - |
| data.product_model.changes.quantified_associations.removed.products | array<oneOf> | - |
| data.product_model.changes.quantified_associations.removed.products (single item) | oneOf | - |
| data.product_model.changes.quantified_associations.removed.products.0 (oneOf item) | string | Product UUID. Default shape when the subscription option send_product_identifier_in_changes is disabled. |
| data.product_model.changes.quantified_associations.removed.products.1 (oneOf item) | object | Product UUID with its main identifier. Shape used when the subscription option send_product_identifier_in_changes is enabled. |
| data.product_model.changes.quantified_associations.removed.products.1.uuid | string | - |
| data.product_model.changes.quantified_associations.removed.products.1.identifier | string | null | Main product identifier, null when the product has none. |
| data.product_model.changes.quantified_associations.removed.product_models | array<string> | - |
| data.product_model.changes.quantified_associations.removed.product_models (single item) | string | - |
| data.product_model.changes.values | object | - |
| data.product_model.changes.values (additional properties) | array<object> | - |
| data.product_model.changes.values.previous | string | number | boolean | object | array<any> | null | Value before the change. Depends on the attribute type. A product link to a product is an object {"type": "product", "id": "<product uuid>"}, with an extra identifier (main product identifier, nullable) when the subscription option send_product_identifier_in_changes is enabled. The same applies to product links inside table cells. |
| data.product_model.changes.values.new | string | number | boolean | object | array<any> | null | Value after the change. Depends on the attribute type. A product link to a product is an object {"type": "product", "id": "<product uuid>"}, with an extra identifier (main product identifier, nullable) when the subscription option send_product_identifier_in_changes is enabled. The same applies to product links inside table cells. |
| data.product_model.changes.values.type | string | - |
| data.product_model.changes.values.locale | string | null | - |
| data.product_model.changes.values.scope | string | null | - |
| data.product_model.changes.table_attributes | object | Changes to table attributes. |
| data.product_model.changes.table_attributes.added | array<object> | - |
| data.product_model.changes.table_attributes.added (single item) | object | - |
| data.product_model.changes.table_attributes.removed | array<object> | - |
| data.product_model.changes.table_attributes.removed (single item) | object | - |
| data.author | object | - |
| data.author.identifier | string | Identifier of the author. |
| data.author.type | string | Type of the author (user, api, job, system, ai-assistant or unknown-user-type). |
Example of payload
Default payload, subscription option send_product_identifier_in_changes disabled: products in the changes are referenced by UUID only.
{
"specversion": "1.0",
"id": "018e32f9-dfe4-760e-a273-5da1c089dfdb",
"type": "com.akeneo.pim.v1.product-model.updated.delta",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-02-22T17:31:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.product-model.updated.delta.schema.json",
"data": {
"product_model": {
"code": "a_product_model_code",
"updated_at": {
"date": "2024-10-14 13:01:21.000000",
"timezone": "UTC"
},
"changes": {
"categories": {
"added": [
"added_category_code_1",
"added_category_code_2"
],
"removed": [
"removed_category_code_1",
"removed_category_code_2"
]
},
"parent": {
"previous": "the_previous_parent_code",
"new": "the_new_parent_code"
},
"values": {
"an_added_attribute": [
{
"previous": null,
"new": "new_data",
"type": "an_attribute_type",
"locale": "a_locale",
"scope": "a_scope"
}
],
"an_updated_attribute": [
{
"previous": "previous_data",
"new": "new_data",
"type": "an_attribute_type",
"locale": "a_locale",
"scope": "a_scope"
}
],
"a_removed_attribute": [
{
"previous": "previous_data",
"new": null,
"type": "an_attribute_type",
"locale": "a_locale",
"scope": "a_scope"
}
],
"an_attribute_with_value_by_locale": [
{
"previous": "previous_data_for_a_locale",
"new": "new_data_for_a_locale",
"type": "an_attribute_type",
"locale": "a_locale",
"scope": "a_scope"
},
{
"previous": "previous_data_for_another_locale",
"new": "new_data_for_another_locale",
"type": "an_attribute_type",
"locale": "another_locale",
"scope": "a_scope"
}
],
"an_attribute_with_value_by_scope": [
{
"previous": "previous_data_for_a_scope",
"new": "new_data_for_a_scope",
"type": "an_attribute_type",
"locale": "a_locale",
"scope": "a_scope"
},
{
"previous": "previous_data_for_another_scope",
"new": "new_data_for_another_scope",
"type": "an_attribute_type",
"locale": "a_locale",
"scope": "another_scope"
}
],
"a_pim_catalog_text_attribute": [
{
"previous": "previous_data",
"new": "new_data",
"type": "pim_catalog_text",
"locale": "a_locale",
"scope": "a_scope"
}
],
"a_pim_catalog_textarea_attribute": [
{
"previous": "previous_data",
"new": "new_data",
"type": "pim_catalog_textarea",
"locale": "a_locale",
"scope": "a_scope"
}
],
"a_pim_catalog_file_attribute": [
{
"previous": {
"file_name": "old_file.json",
"key": "0/e/f/9/0ef94f3e2e8133df2d37dc1e9c88615629707ede_old_file.json"
},
"new": {
"file_name": "new_file.json",
"key": "0/e/f/9/0ef94f3e2e8133df2d37dc1e9c88615629707ede_new_file.json"
},
"type": "pim_catalog_file",
"locale": "a_locale",
"scope": "a_scope"
}
],
"a_pim_catalog_image_attribute": [
{
"previous": {
"file_name": "old_pic.jpg",
"key": "0/e/f/9/0ef94f3e2e8133df2d37dc1e9c88615629707ede_old_pic.jpg"
},
"new": {
"file_name": "new_pic.jpg",
"key": "0/e/f/9/0ef94f3e2e8133df2d37dc1e9c88615629707ede_new_pic.jpg"
},
"type": "pim_catalog_image",
"locale": "a_locale",
"scope": "a_scope"
}
],
"a_pim_catalog_number_attribute": [
{
"previous": 0,
"new": 2,
"type": "pim_catalog_number",
"locale": "a_locale",
"scope": "a_scope"
}
],
"a_pim_catalog_metric_attribute": [
{
"previous": {
"data": "previous_data",
"unit": "a_unit",
"base_data": "previous_based_data",
"base_unit": "a_based_unit",
"family": "a_family"
},
"new": {
"data": "new_data",
"unit": "a_unit",
"base_data": "new_based_data",
"base_unit": "a_based_unit"
},
"type": "pim_catalog_metric",
"locale": "a_locale",
"scope": "a_scope",
"family": "a_family"
}
],
"a_pim_catalog_price_attribute": [
{
"previous": {
"amount": "a_price",
"currency": "a_currency"
},
"new": {
"amount": "another_price",
"currency": "a_currency"
},
"type": "pim_catalog_price",
"locale": "a_locale",
"scope": "a_scope"
}
],
"a_pim_catalog_boolean_attribute": [
{
"previous": true,
"new": false,
"type": "pim_catalog_boolean",
"locale": "a_locale",
"scope": "a_scope"
}
],
"a_pim_catalog_date_attribute": [
{
"previous": "2024-01-01T00:00:00+00:00",
"new": "2024-01-02T00:00:00+00:00",
"type": "pim_catalog_date",
"locale": "a_locale",
"scope": "a_scope"
}
],
"an_identifier_attribute": [
{
"previous": {
"data": "previous_data",
"is_main_identifier": false
},
"new": {
"data": "new_data",
"is_main_identifier": true
},
"type": "pim_catalog_identifier",
"locale": "a_locale",
"scope": "a_scope"
}
],
"a_simple_select_attribute": [
{
"previous": "previous_data",
"new": "new_data",
"type": "pim_catalog_simpleselect",
"locale": "a_locale",
"scope": "a_scope"
}
],
"a_multi_select_attribute": [
{
"previous": [
"value_1",
"value_2"
],
"new": [
"value_1",
"value_3"
],
"type": "pim_catalog_multiselect",
"locale": "a_locale",
"scope": "a_scope"
}
],
"a_pim_catalog_product_link_attribute": [
{
"previous": {
"type": "product",
"id": "83413cad-b3aa-4f68-9b4b-7fc90c1ce84a"
},
"new": {
"type": "product",
"id": "aeabe737-f655-4389-bcc0-d8dd2fc47824"
},
"type": "pim_catalog_product_link",
"locale": "a_locale",
"scope": "a_scope"
}
],
"a_pim_catalog_table_attribute": [
{
"previous": {
"rows": [
{
"cells": [
{
"cell": "cell_1_of_row_1",
"data": "data_of_cell_1_of_row_1"
},
{
"cell": "cell_2_of_row_1",
"data": "data_of_cell_2_of_row_1"
}
]
},
{
"cells": [
{
"cell": "cell_1_of_row_2",
"data": "data_of_cell_1_of_row_2"
},
{
"cell": "cell_2_of_row_2",
"data": "data_of_cell_2_of_row_2"
}
]
}
]
},
"new": {
"rows": [
{
"cells": [
{
"cell": "cell_1_of_row_1",
"data": "data_of_cell_1_of_row_1"
},
{
"cell": "cell_2_of_row_1",
"data": "data_of_cell_2_of_row_1"
}
]
},
{
"cells": [
{
"cell": "cell_1_of_row_2",
"data": "data_of_cell_1_of_row_2"
},
{
"cell": "cell_2_of_row_2",
"data": "data_of_cell_2_of_row_2"
}
]
},
{
"cells": [
{
"cell": "cell_1_of_row_3",
"data": "data_of_cell_1_of_row_3"
},
{
"cell": "cell_2_of_row_3",
"data": "data_of_cell_2_of_row_3"
}
]
}
]
},
"type": "pim_catalog_table",
"locale": "a_locale",
"scope": "a_scope"
}
],
"an_asset_collection_attribute": [
{
"previous": [
"asset_code_1",
"asset_code_2"
],
"new": [
"asset_code_1",
"asset_code_3"
],
"type": "pim_catalog_asset_collection",
"locale": "a_locale",
"scope": "a_scope"
}
],
"an_akeneo_reference_entity_attribute": [
{
"previous": "previous_reference_entity_code",
"new": "new_reference_entity_code",
"type": "akeneo_reference_entity",
"locale": "a_locale",
"scope": "a_scope"
}
],
"an_akeneo_reference_entity_collection_attribute": [
{
"previous": [
"reference_entity_record_code_1",
"reference_entity_record_code_2"
],
"new": [
"reference_entity_record_code_1",
"reference_entity_record_code_3"
],
"type": "akeneo_reference_entity_collection",
"locale": "a_locale",
"scope": "a_scope"
}
]
},
"associations": {
"an_association_type_code": {
"added": {
"products": [
"a_product_uuid_1",
"a_product_uuid_2"
],
"product_models": [
"a_product_model_1",
"a_product_model_2"
],
"groups": [
"an_association_group_1",
"an_association_group_2"
]
},
"removed": {
"products": [
"a_product_uuid_1",
"a_product_uuid_2"
],
"product_models": [
"a_product_model_1",
"a_product_model_2"
],
"groups": [
"an_association_group_1",
"an_association_group_2"
]
}
},
"another_association_type_code": {
"added": {
"products": [
"a_product_uuid_1",
"a_product_uuid_2"
],
"product_models": [
"a_product_model_1",
"a_product_model_2"
],
"groups": [
"an_association_group_1",
"an_association_group_2"
]
},
"removed": {
"products": [
"a_product_uuid_1",
"a_product_uuid_2"
],
"product_models": [
"a_product_model_1",
"a_product_model_2"
],
"groups": [
"an_association_group_1",
"an_association_group_2"
]
}
}
},
"quantified_associations": {
"an_association_type_code": {
"added": {
"products": [
{
"uuid": "an_added_product_uuid",
"quantity": 1
},
{
"uuid": "another_added_product_uuid",
"quantity": 2
}
],
"product_models": [
{
"code": "an_added_product_model_code",
"quantity": 3
},
{
"code": "another_added_product_model_code",
"quantity": 4
}
]
},
"updated": {
"products": [
{
"uuid": "an_updated_product_uuid",
"quantity": 5,
"previous_quantity": 3
}
],
"product_models": [
{
"code": "an_updated_product_model_code",
"quantity": 6,
"previous_quantity": 2
}
]
},
"removed": {
"products": [
"a_product_uuid_1",
"a_product_uuid_2"
],
"product_models": [
"a_product_model_code",
"another_product_model_code"
]
}
},
"another_association_type_code": {
"added": {
"products": [
{
"uuid": "an_added_product_uuid",
"quantity": 1
},
{
"uuid": "another_added_product_uuid",
"quantity": 2
}
],
"product_models": [
{
"code": "an_added_product_model_code",
"quantity": 3
},
{
"code": "another_added_product_model_code",
"quantity": 4
}
]
},
"updated": {
"products": [
{
"uuid": "an_updated_product_uuid",
"quantity": 5,
"previous_quantity": 3
}
],
"product_models": [
{
"code": "an_updated_product_model_code",
"quantity": 6,
"previous_quantity": 2
}
]
},
"removed": {
"products": [
"a_product_uuid_1",
"a_product_uuid_2"
],
"product_models": [
"a_product_model_code",
"another_product_model_code"
]
}
}
}
}
},
"author": {
"identifier": "julia",
"type": "user"
}
}
}
Payload when the subscription option send_product_identifier_in_changes is enabled: products in the changes carry their main identifier.
{
"specversion": "1.0",
"id": "018e32f9-dfe4-760e-a273-5da1c089dfdc",
"type": "com.akeneo.pim.v1.product-model.updated.delta",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-02-22T17:31:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.product-model.updated.delta.schema.json",
"data": {
"product_model": {
"code": "a_product_model_code",
"updated_at": {
"date": "2024-10-14 13:01:21.000000",
"timezone": "UTC"
},
"changes": {
"values": {
"a_pim_catalog_product_link_attribute": [
{
"previous": {
"type": "product",
"id": "83413cad-b3aa-4f68-9b4b-7fc90c1ce84a",
"identifier": "a_previous_product_identifier"
},
"new": {
"type": "product",
"id": "aeabe737-f655-4389-bcc0-d8dd2fc47824",
"identifier": "a_new_product_identifier"
},
"type": "pim_catalog_product_link",
"locale": "a_locale",
"scope": "a_scope"
}
]
},
"associations": {
"an_association_type_code": {
"added": {
"products": [
{
"uuid": "a_product_uuid_1",
"identifier": "a_product_identifier_1"
},
{
"uuid": "a_product_uuid_2",
"identifier": "a_product_identifier_2"
}
],
"product_models": [
"a_product_model_1"
],
"groups": [
"an_association_group_1"
]
},
"removed": {
"products": [
{
"uuid": "a_product_uuid_3",
"identifier": "a_product_identifier_3"
},
{
"uuid": "a_product_uuid_4",
"identifier": null
}
],
"product_models": [
"a_product_model_2"
],
"groups": [
"an_association_group_2"
]
}
}
},
"quantified_associations": {
"a_quantified_association_type_code": {
"added": {
"products": [
{
"uuid": "an_added_product_uuid",
"identifier": "an_added_product_identifier",
"quantity": 1
}
],
"product_models": [
{
"code": "an_added_product_model_code",
"quantity": 3
}
]
},
"updated": {
"products": [
{
"uuid": "an_updated_product_uuid",
"identifier": "an_updated_product_identifier",
"quantity": 5,
"previous_quantity": 3
}
],
"product_models": [
{
"code": "an_updated_product_model_code",
"quantity": 6,
"previous_quantity": 2
}
]
},
"removed": {
"products": [
{
"uuid": "a_removed_product_uuid",
"identifier": "a_removed_product_identifier"
}
],
"product_models": [
"a_removed_product_model_code"
]
}
}
}
}
}
}
}
#com.akeneo.pim.v1.product-model.deleted
This event is generated whenever a product model is deleted from the PIM.
- Message ID:
com.akeneo.pim.v1.product-model.deleted - Content type: application/json
#Payload
| Name | Type | Description |
|---|---|---|
| data.product_model | object | - |
| data.product_model.code | string | Unique identifier of a Product Model in the PIM. |
| data.author | object | - |
| data.author.identifier | string | Identifier of the author. |
| data.author.type | string | Type of the author (user, api, job, system, ai-assistant or unknown-user-type). |
Example of payload
{
"specversion": "1.0",
"id": "b6f4add4-f3d1-4502-8cf0-0f228e054ce5",
"type": "com.akeneo.pim.v1.product-model.deleted",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-06-10T17:31:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.product-model.deleted.schema.json",
"data": {
"product_model": {
"code": "a-product-model-code"
},
"author": {
"identifier": "b238e9f7-fcec-45bd-9431-d43cd624b244",
"type": "user"
}
}
}
#com.akeneo.pim.v1.family.created
This event is generated whenever a new family is created in the PIM.
- Message ID:
com.akeneo.pim.v1.family.created - Content type: application/json
#Payload
| Name | Type | Description |
|---|---|---|
| data.family | object | - |
| data.family.code | string | code of a family |
| data.author | object | - |
| data.author.identifier | string | Identifier of the author. |
| data.author.type | string | Type of the author (user, api, job, system, ai-assistant or unknown-user-type). |
Example of payload
{
"specversion": "1.0",
"id": "018e32f9-dfe4-760e-a273-5da1c089dfdb",
"type": "com.akeneo.pim.v1.family.created",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-02-22T17:31:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.family.created.schema.json",
"data": {
"family": {
"code": "a_family_code"
},
"author": {
"identifier": "b238e9f7-fcec-45bd-9431-d43cd624b244",
"type": "user"
}
}
}
#com.akeneo.pim.v1.family.updated
This event is generated whenever an existing family is modified in the PIM.
- Message ID:
com.akeneo.pim.v1.family.updated - Content type: application/json
The event is triggered when any of the following properties are changed:
- The attribute as image.
- The attribute requirements.
- The labels.
#Payload
| Name | Type | Description |
|---|---|---|
| data.family | object | - |
| data.family.code | string | code of a family |
| data.author | object | - |
| data.author.identifier | string | Identifier of the author. |
| data.author.type | string | Type of the author (user, api, job, system, ai-assistant or unknown-user-type). |
Example of payload
{
"specversion": "1.0",
"id": "018e32f9-dfe4-760e-a273-5da1c089dfdb",
"type": "com.akeneo.pim.v1.family.updated",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-02-22T17:31:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.family.updated.schema.json",
"data": {
"family": {
"code": "a_family_code"
},
"author": {
"identifier": "b238e9f7-fcec-45bd-9431-d43cd624b244",
"type": "user"
}
}
}
#com.akeneo.pim.v1.family.deleted
This event is generated whenever a family is deleted from the PIM.
- Message ID:
com.akeneo.pim.v1.family.deleted - Content type: application/json
#Payload
| Name | Type | Description |
|---|---|---|
| data.family | object | - |
| data.family.code | string | code of a family |
| data.author | object | - |
| data.author.identifier | string | Identifier of the author. |
| data.author.type | string | Type of the author (user, api, job, system, ai-assistant or unknown-user-type). |
Example of payload
{
"specversion": "1.0",
"id": "018e32f9-dfe4-760e-a273-5da1c089dfdb",
"type": "com.akeneo.pim.v1.family.deleted",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-02-22T17:31:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.family.deleted.schema.json",
"data": {
"family": {
"code": "a_family_code"
},
"author": {
"identifier": "2e7b105e-3528-4bf7-8e83-678ec2cde0f0",
"type": "api"
}
}
}
#com.akeneo.pim.v1.family-variant.created
This event is generated whenever a new family variant is created in the PIM.
- Message ID:
com.akeneo.pim.v1.family-variant.created - Content type: application/json
#Payload
| Name | Type | Description |
|---|---|---|
| data.family_variant | object | - |
| data.family_variant.code | string | Unique identifier of a Family Variant in the PIM. |
| data.family_variant.family | object | - |
| data.family_variant.family.code | string | Unique identifier of a Family in the PIM. |
| data.author | object | - |
| data.author.identifier | string | Identifier of the author. |
| data.author.type | string | Type of the author (user, api, job, system, ai-assistant or unknown-user-type). |
Example of payload
{
"specversion": "1.0",
"id": "b6f4add4-f3d1-4502-8cf0-0f228e054ce5",
"type": "com.akeneo.pim.v1.family-variant.created",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-06-10T17:31:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.family-variant.created.schema.json",
"data": {
"family_variant": {
"code": "a-family-variant-code",
"family": {
"code": "a-family-code"
}
},
"author": {
"identifier": "b238e9f7-fcec-45bd-9431-d43cd624b244",
"type": "user"
}
}
}
#com.akeneo.pim.v1.family-variant.updated
This event is generated whenever a family variant is updated in the PIM.
- Message ID:
com.akeneo.pim.v1.family-variant.updated - Content type: application/json
#Payload
| Name | Type | Description |
|---|---|---|
| data.family_variant | object | - |
| data.family_variant.code | string | Unique identifier of a Family Variant in the PIM. |
| data.family_variant.family | object | - |
| data.family_variant.family.code | string | Unique identifier of the Family this variant belongs to. |
| data.author | object | - |
| data.author.identifier | string | Identifier of the author. |
| data.author.type | string | Type of the author (user, api, job, system, ai-assistant or unknown-user-type). |
Example of payload
{
"specversion": "1.0",
"id": "018e32f9-dfe4-760e-a273-5da1c089dfdb",
"type": "com.akeneo.pim.v1.family-variant.updated",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-02-22T17:31:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.family-variant.updated.schema.json",
"data": {
"family_variant": {
"code": "a_family_variant_code",
"family": {
"code": "a_family_code"
}
},
"author": {
"identifier": "b238e9f7-fcec-45bd-9431-d43cd624b244",
"type": "user"
}
}
}
#com.akeneo.pim.v1.family-variant.deleted
This event is generated whenever a family variant is deleted from the PIM.
- Message ID:
com.akeneo.pim.v1.family-variant.deleted - Content type: application/json
#Payload
| Name | Type | Description |
|---|---|---|
| data.family_variant | object | - |
| data.family_variant.code | string | Unique identifier of a Family Variant in the PIM. |
| data.family_variant.family | object | - |
| data.family_variant.family.code | string | Unique identifier of the Family this variant belongs to. |
| data.author | object | - |
| data.author.identifier | string | Identifier of the author. |
| data.author.type | string | Type of the author (user, api, job, system, ai-assistant or unknown-user-type). |
Example of payload
{
"specversion": "1.0",
"id": "018e32f9-dfe4-760e-a273-5da1c089dfdb",
"type": "com.akeneo.pim.v1.family-variant.deleted",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-02-22T17:31:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.family-variant.deleted.schema.json",
"data": {
"family_variant": {
"code": "a_family_variant_code",
"family": {
"code": "a_family_code"
}
},
"author": {
"identifier": "b238e9f7-fcec-45bd-9431-d43cd624b244",
"type": "user"
}
}
}
#com.akeneo.pim.v1.reference-entity-record.created
This event is generated whenever a new reference entity record is created in the PIM.
- Message ID:
com.akeneo.pim.v1.reference-entity-record.created - Content type: application/json
#Payload
| Name | Type | Description |
|---|---|---|
| data.reference_entity_record | object | - |
| data.reference_entity_record.reference_entity | object | - |
| data.reference_entity_record.reference_entity.code | string | identifier of a reference entity |
| data.reference_entity_record.code | string | Unique identifier of a reference entity record |
| data.author | object | - |
| data.author.identifier | string | Identifier of the author. |
| data.author.type | string | Type of the author (user, api, job, system, ai-assistant or unknown-user-type). |
Example of payload
{
"specversion": "1.0",
"id": "6e523497-8231-4892-8f9f-895378b4d045",
"type": "com.akeneo.pim.v1.reference-entity-record.created",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-06-13T10:17:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.reference-entity-record.created.schema.json",
"data": {
"reference_entity_record": {
"code": "Addadas",
"reference_entity": {
"code": "brands"
}
},
"author": {
"identifier": "peter",
"type": "user"
}
}
}
#com.akeneo.pim.v1.reference-entity-record.updated
This event is generated whenever an existing reference entity record is modified in the PIM.
- Message ID:
com.akeneo.pim.v1.reference-entity-record.updated - Content type: application/json
The event is triggered when any changes are made to the record values.
#Payload
| Name | Type | Description |
|---|---|---|
| data.reference_entity_record | object | - |
| data.reference_entity_record.reference_entity | object | - |
| data.reference_entity_record.reference_entity.code | string | identifier of a reference entity |
| data.reference_entity_record.code | string | Unique identifier of a reference entity record |
| data.author | object | - |
| data.author.identifier | string | Identifier of the author. |
| data.author.type | string | Type of the author (user, api, job, system, ai-assistant or unknown-user-type). |
Example of payload
{
"specversion": "1.0",
"id": "6e523497-8231-4892-8f9f-895378b4d045",
"type": "com.akeneo.pim.v1.reference-entity-record.updated",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-06-13T10:17:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.reference-entity-record.updated.schema.json",
"data": {
"reference_entity_record": {
"code": "Addadas",
"reference_entity": {
"code": "brands"
}
},
"author": {
"identifier": "system",
"type": "system"
}
}
}
#com.akeneo.pim.v1.reference-entity-record.updated.delta
This event is generated whenever an existing reference entity record is modified in the PIM and includes the changed attributes.
- Message ID:
com.akeneo.pim.v1.reference-entity-record.updated.delta - Content type: application/json
The event is triggered when any changes are made to the record attribute values and includes a delta of the changes with previous and new values. Each attribute change includes the type, locale, and channel information.
#Payload
| Name | Type | Description |
|---|---|---|
| data.reference_entity_record | object | - |
| data.reference_entity_record.reference_entity | object | - |
| data.reference_entity_record.reference_entity.code | string | identifier of a reference entity |
| data.reference_entity_record.code | string | Unique identifier of a reference entity record |
| data.reference_entity_record.updated_at | object | - |
| data.reference_entity_record.updated_at.date | string | Date and time when the record was updated |
| data.reference_entity_record.updated_at.timezone | string | Timezone of the update timestamp |
| data.reference_entity_record.changes | object | Details about the changes made to the reference entity record. |
| data.reference_entity_record.changes.values | object | Dictionary of changed attribute values with their previous and new values |
| data.reference_entity_record.changes.values (additional properties) | array<object> | - |
| data.reference_entity_record.changes.values.previous | string | number | boolean | object | array<any> | null | Previous value of the attribute |
| data.reference_entity_record.changes.values.new | string | number | boolean | object | array<any> | null | New value of the attribute |
| data.reference_entity_record.changes.values.type | string | Type of the attribute |
| data.reference_entity_record.changes.values.locale | string | null | Locale code if the attribute is localizable, null otherwise |
| data.reference_entity_record.changes.values.channel | string | null | Channel code if the attribute is scopable, null otherwise |
| data.author | object | - |
| data.author.identifier | string | Identifier of the author. |
| data.author.type | string | Type of the author (user, api, job, system, ai-assistant or unknown-user-type). |
Example of payload
{
"specversion": "1.0",
"id": "6da0f87c-365d-414c-915a-c49d228dc5a8",
"type": "com.akeneo.pim.v1.reference-entity-record.updated.delta",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-06-13T10:17:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.reference-entity-record.updated.delta.schema.json",
"data": {
"reference_entity_record": {
"code": "Addadas",
"reference_entity": {
"code": "brands"
},
"updated_at": {
"date": "2024-06-13 10:17:00.000000",
"timezone": "UTC"
},
"changes": {
"values": {
"description": [
{
"previous": "Old description text",
"new": "New description text",
"type": "text",
"locale": "en_US",
"channel": "ecommerce"
},
{
"previous": null,
"new": "Description en français",
"type": "text",
"locale": "fr_FR",
"channel": "ecommerce"
}
],
"year": [
{
"previous": "2023",
"new": "2024",
"type": "number",
"locale": null,
"channel": null
}
],
"logo": [
{
"previous": {
"filePath": "1/2/3/old_logo.jpg",
"originalFilename": "old_logo.jpg",
"size": 1024,
"mimeType": "image/jpeg",
"extension": "jpg"
},
"new": {
"filePath": "4/5/6/new_logo.jpg",
"originalFilename": "new_logo.jpg",
"size": 2048,
"mimeType": "image/jpeg",
"extension": "jpg"
},
"type": "image",
"locale": "en_US",
"channel": "ecommerce"
}
]
}
}
},
"author": {
"identifier": "7d050823-997a-4eb0-9ddb-f236092c080e",
"type": "user"
}
}
}
#com.akeneo.pim.v1.reference-entity-record.deleted
This event is generated whenever a reference entity record is deleted from the PIM.
- Message ID:
com.akeneo.pim.v1.reference-entity-record.deleted - Content type: application/json
#Payload
| Name | Type | Description |
|---|---|---|
| data.reference_entity_record | object | - |
| data.reference_entity_record.reference_entity | object | - |
| data.reference_entity_record.reference_entity.code | string | identifier of a reference entity |
| data.reference_entity_record.code | string | Unique identifier of a reference entity record |
| data.author | object | - |
| data.author.identifier | string | Identifier of the author. |
| data.author.type | string | Type of the author (user, api, job, system, ai-assistant or unknown-user-type). |
Example of payload
{
"specversion": "1.0",
"id": "6e523497-8231-4892-8f9f-895378b4d045",
"type": "com.akeneo.pim.v1.reference-entity-record.deleted",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-06-13T10:17:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.reference-entity-record.deleted.schema.json",
"data": {
"reference_entity_record": {
"code": "Addadas",
"reference_entity": {
"code": "brands"
}
},
"author": {
"identifier": "92e5893f-468b-486a-9a7e-d8c656d0a79c",
"type": "user"
}
}
}
#com.akeneo.pim.v1.job.export.status-changed
This event is generated whenever a job export is triggered.
- Message ID:
com.akeneo.pim.v1.job.export.status-changed - Content type: application/json
This event is triggered for various types of export jobs in the PIM system. The following export job types are available:
asset_manager_csv_asset_exportasset_manager_xlsx_asset_exportcsv_enriched_category_exportxlsx_enriched_category_exportcsv_product_exportxlsx_product_exportcsv_tailored_product_exportxlsx_tailored_product_exportcsv_product_model_exportxlsx_product_model_exportcsv_tailored_product_model_exportxlsx_tailored_product_model_exportcsv_reference_entity_record_exportxlsx_reference_entity_record_exportcsv_attribute_exportxlsx_attribute_exportcsv_attribute_option_exportxlsx_attribute_option_exportcsv_attribute_group_exportxlsx_attribute_group_exportcsv_category_exportxlsx_category_exportcsv_family_exportxlsx_family_exportcsv_channel_exportxlsx_channel_exportcsv_locale_exportxlsx_locale_exportcsv_association_type_exportxlsx_association_type_export
The code field in the event payload contains the specific job code that was executed.
#Payload
| Name | Type | Description |
|---|---|---|
| data.job | object | - |
| data.job.execution_id | integer | Job execution id |
| data.job.code | string | Job code |
| data.job.name | string | Job name |
| data.job.label | string | Job label |
| data.job.status | string | Job execution status |
| data.job.total_rows | integer | Total rows |
| data.job.filename | string | File name |
| data.job.start_time | string | Job execution start time |
| data.job.end_time | string | Job execution end time |
| data.author | object | - |
| data.author.identifier | string | Identifier of the author. |
| data.author.type | string | Type of the author (user, api, job, system, ai-assistant or unknown-user-type). |
Example of payload
{
"specversion": "1.0",
"id": "6e523497-8231-4892-8f9f-895378b4d045",
"type": "com.akeneo.pim.v1.job.export.status-changed",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-06-13T10:17:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.job.export.status-changed.schema.json",
"data": {
"job": {
"execution_id": 233,
"code": "code",
"name": "job_name",
"label": "job label",
"total_rows": 10,
"filename": "job_export.csv",
"start_time": "2024-06-13T10:17:00+00:00",
"end_time": null,
"status": "starting"
},
"author": {
"identifier": "julia",
"type": "user"
}
}
}
#com.akeneo.pim.v1.job.mass-edit.status-changed
This event is generated whenever a mass edit action is triggered.
- Message ID:
com.akeneo.pim.v1.job.mass-edit.status-changed - Content type: application/json
#Payload
| Name | Type | Description |
|---|---|---|
| data.job | object | - |
| data.job.execution_id | integer | Job execution id |
| data.job.code | string | Job code |
| data.job.name | string | Job name |
| data.job.label | string | Job label |
| data.job.status | string | Job execution status |
| data.job.read | integer | Total rows |
| data.job.start_time | string | Job execution start time |
| data.job.end_time | string | Job execution end time |
| data.author | object | - |
| data.author.identifier | string | Identifier of the author. |
| data.author.type | string | Type of the author (user, api, job, system, ai-assistant or unknown-user-type). |
Example of payload
{
"specversion": "1.0",
"id": "6e523497-8231-4892-8f9f-895378b4d045",
"type": "com.akeneo.pim.v1.job.mass-edit.status-changed",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-06-13T10:17:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.job.mass-edit.status-changed.schema.json",
"data": {
"job": {
"execution_id": 233,
"code": "code",
"name": "job_name",
"label": "job label",
"read": 10,
"start_time": "2024-06-13T10:17:00+00:00",
"end_time": null,
"status": "starting"
},
"author": {
"identifier": "julia",
"type": "user"
}
}
}
#com.akeneo.pim.v1.job.import.status-changed
This event is generated whenever a job import is executed.
- Message ID:
com.akeneo.pim.v1.job.import.status-changed - Content type: application/json
#Payload
| Name | Type | Description |
|---|---|---|
| data.job | object | - |
| data.job.execution_id | integer | Job execution id |
| data.job.code | string | Job code |
| data.job.name | string | Job name |
| data.job.label | string | Job label |
| data.job.status | string | Job execution status |
| data.job.total_rows | integer | Total rows |
| data.job.total_rows_processed | integer | Total rows processed |
| data.job.total_rows_skipped | integer | Total rows skipped |
| data.job.total_warnings | integer | Total warnings |
| data.job.filename | string | File name |
| data.job.start_time | string | Job execution start time |
| data.job.end_time | string | Job execution end time |
| data.author | object | - |
| data.author.identifier | string | Identifier of the author. |
| data.author.type | string | Type of the author (user, api, job, system, ai-assistant or unknown-user-type). |
Example of payload
{
"specversion": "1.0",
"id": "6e523497-8231-4892-8f9f-895378b4d045",
"type": "com.akeneo.pim.v1.job.import.status-changed",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-06-13T10:17:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.job.import.status-changed.schema.json",
"data": {
"job": {
"execution_id": 11,
"code": "code",
"name": "job_name",
"label": "job label",
"total_rows": 10,
"total_rows_processed": 10,
"total_rows_skipped": 0,
"total_warnings": 0,
"filename": "job_import.csv",
"start_time": "2024-06-13T10:17:00+00:00",
"end_time": null,
"status": "starting"
},
"author": {
"identifier": "julia",
"type": "user"
}
}
}
#com.akeneo.pim.v1.workflow.execution.started
This event is generated whenever a new workflow execution is started in the PIM.
- Message ID:
com.akeneo.pim.v1.workflow.execution.started - Content type: application/json
#Payload
| Name | Type | Description |
|---|---|---|
| data.workflow | object | The workflow on which an execution has started. |
| data.workflow.uuid | string | Unique identifier of the workflow. |
| data.author | object | - |
| data.author.identifier | string | Identifier of the author. |
| data.author.type | string | Type of the author (user, api, job, system, ai-assistant or unknown-user-type). |
| data.product | object | (Conditional) Present if the task is on a product. |
| data.product.uuid | string | Unique identifier of a Product in the PIM. |
| data.product_model | object | (Conditional) Present if the task is on a product model. |
| data.product_model.code | string | Code of a Product Model in the PIM. |
Example of payload
{
"specversion": "1.0",
"id": "b6f4add4-f3d1-4502-8cf0-0f228e054ce5",
"type": "com.akeneo.pim.v1.workflow.execution.started",
"source": "pim",
"subject": "srnt-whatever",
"time": "2024-06-10T17:31:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.workflow.execution.started.schema.json",
"data": {
"workflow": {
"uuid": "78e72192-8989-4a10-a121-09fc8cf921ff"
},
"product": {
"uuid": "3f46aa75-ed30-4b17-8e26-11f7d360f647"
},
"author": {
"identifier": "system",
"type": "system"
}
}
}
#com.akeneo.pim.v1.workflow.execution.completed
This event is generated whenever a workflow execution is completed in the PIM.
- Message ID:
com.akeneo.pim.v1.workflow.execution.completed - Content type: application/json
#Payload
| Name | Type | Description |
|---|---|---|
| data.workflow | object | The workflow on which an execution was completed. |
| data.workflow.uuid | string | Unique identifier of the workflow. |
| data.author | object | - |
| data.author.identifier | string | Identifier of the author. |
| data.author.type | string | Type of the author (user, api, job, system, ai-assistant or unknown-user-type). |
| data.product | object | (Conditional) Present if the task is on a product. |
| data.product.uuid | string | Unique identifier of a Product in the PIM. |
| data.product_model | object | (Conditional) Present if the task is on a product model. |
| data.product_model.code | string | Code of a Product Model in the PIM. |
Example of payload
{
"specversion": "1.0",
"id": "b6f4add4-f3d1-4502-8cf0-0f228e054ce5",
"type": "com.akeneo.pim.v1.workflow.execution.completed",
"source": "pim",
"subject": "srnt-whatever",
"time": "2024-06-10T17:31:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.workflow.execution.completed.schema.json",
"data": {
"workflow": {
"uuid": "78e72192-8989-4a10-a121-09fc8cf921ff"
},
"product": {
"uuid": "3f46aa75-ed30-4b17-8e26-11f7d360f647"
},
"author": {
"identifier": "system",
"type": "system"
}
}
}
#com.akeneo.pim.v1.workflow.task.created
This event is generated whenever a new workflow task is created in the PIM.
- Message ID:
com.akeneo.pim.v1.workflow.task.created - Content type: application/json
#Payload
| Name | Type | Description |
|---|---|---|
| data.workflow | object | The workflow to which the task belongs. |
| data.workflow.uuid | string | Unique identifier of the workflow. |
| data.task | object | The created task. |
| data.task.uuid | string | Unique identifier of the task. |
| data.task.rejected | boolean | Whether the task was rejected or not. |
| data.step | object | The step to which the task belongs. |
| data.step.uuid | string | Unique identifier of the step. |
| data.author | object | - |
| data.author.identifier | string | Identifier of the author. |
| data.author.type | string | Type of the author (user, api, job, system, ai-assistant or unknown-user-type). |
| data.product | object | (Conditional) Present if the task is on a product. |
| data.product.uuid | string | Unique identifier of a Product in the PIM. |
| data.product_model | object | (Conditional) Present if the task is on a product model. |
| data.product_model.code | string | Code of a Product Model in the PIM. |
Example of payload
{
"specversion": "1.0",
"id": "b6f4add4-f3d1-4502-8cf0-0f228e054ce5",
"type": "com.akeneo.pim.v1.workflow.task.created",
"source": "pim",
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
"time": "2024-06-10T17:31:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.workflow.task.created.schema.json",
"data": {
"task": {
"uuid": "fecf6c43-f56a-4107-aac1-0b9eb7b0bf84",
"rejected": false
},
"workflow": {
"uuid": "78e72192-8989-4a10-a121-09fc8cf921ff"
},
"step": {
"uuid": "6f37476a-04c2-46c0-b6d0-e18316959068"
},
"product": {
"uuid": "7108ee60-a1ea-4fe1-baca-b39909e23d24"
},
"author": {
"identifier": "system",
"type": "system"
}
}
}
#com.akeneo.pim.v1.workflow.task.completed
This event is generated whenever an workflow task is completed in a workflow.
- Message ID:
com.akeneo.pim.v1.workflow.task.completed - Content type: application/json
#Payload
| Name | Type | Description |
|---|---|---|
| data.workflow | object | The workflow to which the task belongs. |
| data.workflow.uuid | string | Unique identifier of the workflow. |
| data.task | object | The completed task. |
| data.task.uuid | string | Unique identifier of the task. |
| data.step | object | The step to which the task belongs. |
| data.step.uuid | string | Unique identifier of the step. |
| data.author | object | - |
| data.author.identifier | string | Identifier of the author. |
| data.author.type | string | Type of the author (user, api, job, system, ai-assistant or unknown-user-type). |
| data.product | object | (Conditional) Present if the task is on a product. |
| data.product.uuid | string | Unique identifier of a Product in the PIM. |
| data.product_model | object | (Conditional) Present if the task is on a product model. |
| data.product_model.code | string | Code of a Product Model in the PIM. |
Example of payload
{
"specversion": "1.0",
"id": "b6f4add4-f3d1-4502-8cf0-0f228e054ce5",
"type": "com.akeneo.pim.v1.workflow.task.completed",
"source": "pim",
"subject": "srnt-whatever",
"time": "2024-06-10T17:31:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.workflow.task.completed.schema.json",
"data": {
"task": {
"uuid": "d0426261-f533-47f4-9eb7-2a6fccde2fe8"
},
"workflow": {
"uuid": "78e72192-8989-4a10-a121-09fc8cf921ff"
},
"step": {
"uuid": "fecf6c43-f56a-4107-aac1-0b9eb7b0bf84"
},
"product": {
"uuid": "3f46aa75-ed30-4b17-8e26-11f7d360f647"
},
"author": {
"identifier": "system",
"type": "system"
}
}
}
#com.akeneo.pim.v1.activity.data-access
Common Information Model compliant data access audit event.
- Message ID:
com.akeneo.pim.v1.activity.data-access - Content type: application/json
This event describes a user accessing a resource in the PIM, following the Common Information Model (CIM) Data Access data model. This event is available exclusively to customers who subscribed to the Akeneo Product Cloud Premium package.
#Payload
| Name | Type | Description |
|---|---|---|
| data.action | string | The action performed on the resource. |
| data.user | string | The user or entity performing the action. |
| data.user_name | string | Friendly username of the user performing the action. |
| data.user_agent | string | User agent of the client that performed the action. |
| data.src | string | The source from which the action originated (client IP). |
| data.dest | string | The PIM instance where the action occurred (its URL/host). |
| data.object | string | Name of the affected resource object. |
| data.object_category | string | Generic class of the affected resource object. |
| data.object_id | string | Unique identifier of the affected resource object. |
| data.object_attrs | object | Attributes describing the access. The shape depends on the kind of access: an outcome for a direct access, a data transfer for an import/export, or a bulk operation. |
| data.object_attrs.access_outcome | string | Outcome of a direct resource access. |
| data.object_attrs.transfer_type | string | Direction of a data transfer (import/export launch). |
| data.object_attrs.operation | string | The bulk operation launched (e.g. batch_update, batch_delete). |
| data.object_attrs.changes | object | Per-field before/after values for a modification. The password value is redacted. |
| data.object_attrs.changes (additional properties) | object | - |
| data.signature | string | Human-readable signature for a denied or errored access. |
| data.timestamp | string | The request time, as an ISO 8601 timestamp. |
| data.vendor_product | string | The vendor and product that detected the action. |
Example of payload
{
"specversion": "1.0",
"id": "018e32f9-dfe4-760e-a273-5da1c089dfdb",
"type": "com.akeneo.pim.v1.activity.data-access",
"source": "pim",
"time": "2024-02-22T17:31:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.activity.data-access.schema.json",
"data": {
"action": "read",
"user": "julia",
"user_name": "julia",
"user_agent": "Mozilla/5.0",
"src": "203.0.113.1",
"dest": "example.cloud.akeneo.com",
"object": "product",
"object_category": "product",
"object_id": "my_product",
"object_attrs": {
"access_outcome": "success"
},
"vendor_product": "Akeneo PIM"
}
}
#com.akeneo.pim.v1.activity.authentication
Common Information Model compliant authentication audit event.
- Message ID:
com.akeneo.pim.v1.activity.authentication - Content type: application/json
This event describes a user authenticating to or logging out of the PIM, following the Common Information Model (CIM). This event is available exclusively to customers who subscribed to the Akeneo Product Cloud Premium package.
#Payload
| Name | Type | Description |
|---|---|---|
| data.action | string | The outcome of the authentication. |
| data.user | string | The user attempting to authenticate. |
| data.app | string | The application the user authenticates against. |
| data.src | string | The source from which the authentication originated (client IP). |
| data.dest | string | The target of the authentication (tenant). |
| data.authentication_method | string | The method used to authenticate. |
| data.signature | string | A human-readable signature, e.g. logout. |
| data.reason | string | The reason for an authentication failure. |
| data.user_agent | string | User agent of the client that performed the authentication. |
| data.timestamp | string | The request time, as an ISO 8601 timestamp. |
| data.vendor_product | string | The vendor and product that detected the event. |
Example of payload
{
"specversion": "1.0",
"id": "018e32f9-dfe4-760e-a273-5da1c089dfdb",
"type": "com.akeneo.pim.v1.activity.authentication",
"source": "pim",
"time": "2024-02-22T17:31:00Z",
"datacontenttype": "application/json",
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.activity.authentication.schema.json",
"data": {
"action": "success",
"user": "julia",
"user_agent": "Mozilla/5.0",
"src": "203.0.113.1",
"app": "example.cloud.akeneo.com",
"dest": "example.cloud.akeneo.com",
"authentication_method": "password",
"vendor_product": "Akeneo PIM"
}
}