This page provides the list of events and associated payload for internal events (via RabbitMQ/AWS MQ) and external events (via EventBridge) for the Feeds microservice.
External Events via EventBridge
The following events contain the entity changed in the event message payload.
List of Events
| S.No. | API call | Call detail | Event Type | Identifier |
|---|---|---|---|---|
| 1. | POST | CreateFeedJob | feedservice/feedjob/create | response_feedId |
| 2. | POST | CreateFeed | feedservice/feed/create | response_feedId |
| 3. | POST | CreateSchedule | feedservice/schedule/create | response_scheduleId |
| 4. | DELETE | DeleteFeedJob | feedservice/feedjob/delete | request_feedId |
| 5. | DELETE | DeleteFeed | feedservice/feed/delete | request_feedRequest.feedId |
| 6. | DELETE | DeleteSchedule | feedservice/schedule/delete | request_feedId |
| 7. | PATCH | PatchUpdateFeedJob | feedservice/feedjob/patch | response_feedId |
| 8. | PATCH | PatchUpdateFeed | feedservice/feed/patch | response_feedId |
| 9. | PATCH | PatchUpdateSchedule | feedservice/schedule/patch | response_scheduleId |
| 10. | PUT | UpdateFeedJob | feedservice/feedjob/update | response_feedId |
| 11. | PUT | UpdateFeed | feedservice/feed/update | response_feedId |
| 12. | PUT | UpdateSchedule | feedservice/schedule/update | response_scheduleId |
Payload
CreateFeedJob
Event Type: feedservice/feedjob/create
{
"version": "0",
"id": "e607d470-8d05-e7a4-ac63-89cbf41ee0d5",
"detail-type": "feedservice/feedjob/create",
"source": "feedservice",
"account": "277827593990",
"time": "2024-05-22T05:58:43Z",
"region": "us-east-1",
"resources": [
],
"detail": {
"id": "catalogImport_1716357501848",
"timestamp": 1716357523123,
"payload": {
"feedId": "catalogImport_1716357501848",
"jobId": "1716357523096_catalogimport",
"businessId": 1,
"collectionId": "1",
"serviceType": "catalog",
"name": "1716357523096_catalogimport",
"description": "string",
"status": "ACTIVE",
"jobParams": [
{
"name": "string",
"stringValue": "string"
}
],
"createdOn": "2024-05-22T05:58:43.115327582",
"createdBy": 111,
"updatedOn": "2024-05-22T05:58:43.115328138",
"updatedBy": 111,
"maxRunTime": 1800
},
"collectionId": "1",
"eventType": "feedservice/feedjob/create",
"userId": "111",
"actOnBehalfOfUser": 0,
"roles": [
"ROLE_FEED_ADMIN"
],
"channel": "CSR"
}
}CreateFeed
Event Type: feedservice/feed/create
{
"version": "0",
"id": "9f6bcdbf-614b-a167-39aa-2fa91ecb3e4c",
"detail-type": "feedservice/feed/create",
"source": "feedservice",
"account": "277827593990",
"time": "2024-05-22T05:58:21Z",
"region": "us-east-1",
"resources": [
],
"detail": {
"id": "catalogImport_1716357501848",
"timestamp": 1716357501885,
"payload": {
"feedId": "catalogImport_1716357501848",
"serviceType": "catalog",
"serviceConfigs": [
"string"
],
"name": "catalogImport_1716357501848",
"description": "string",
"jobInfo": {
"jobId": "string",
"jobPath": "/skava-pedev/catalog/import/job/catalogImport_1716357501848",
"jobParams": [
"string"
],
"scheduleParams": [
"string"
]
},
"allowParllelExecution": false,
"executionCluster": "string",
"createdOn": "2024-05-22T05:58:21.868504327",
"createdBy": 0,
"updatedOn": "2024-05-22T05:58:21.868505596",
"updatedBy": 0,
"maxRunTime": 1800
},
"eventType": "feedservice/feed/create",
"userId": "111",
"actOnBehalfOfUser": 0,
"roles": [
"ROLE_FEED_ADMIN"
],
"channel": "CSR"
}
}CreateSchedule
Event Type: feedservice/schedule/create
{
"version": "0",
"id": "038e885a-5b6b-17b3-e367-1f5736565b2d",
"detail-type": "feedservice/schedule/create",
"source": "feedservice",
"account": "277827593990",
"time": "2024-05-22T05:59:05Z",
"region": "us-east-1",
"resources": [
],
"detail": {
"id": "ScheduleId_1716357545091",
"timestamp": 1716357545118,
"payload": {
"scheduleId": "ScheduleId_1716357545091",
"businessId": 1,
"collectionId": "1",
"feedId": "catalogImport_1716357501848",
"jobId": "1716357523096_catalogimport",
"name": "string",
"description": "string",
"status": "INACTIVE",
"state": "WAITING",
"repeatInterval": 0,
"feedInterval": 0,
"maxRunTime": 0,
"startTime": "2023-05-05T07:56:47.771360",
"endTime": "2023-05-05T07:58:47.771360",
"params": [
{
"name": "string",
"stringValue": "string"
}
],
"createdOn": "2024-05-22T05:59:05.109877168",
"createdBy": 111,
"updatedOn": "2024-05-22T05:59:05.109877536",
"updatedBy": 111,
"serviceType": "catalog"
},
"collectionId": "1",
"eventType": "feedservice/schedule/create",
"userId": "111",
"actOnBehalfOfUser": 0,
"roles": [
"ROLE_FEED_ADMIN"
],
"channel": "CSR"
}
}DeleteFeedJob
Event Type: feedservice/feedjob/delete
{
"version": "0",
"id": "47c84bda-a09f-4b7a-64c4-50624a58554d",
"detail-type": "feedservice/feedjob/delete",
"source": "feedservice",
"account": "277827593990",
"time": "2024-05-22T05:58:59Z",
"region": "us-east-1",
"resources": [
],
"detail": {
"id": "catalogImport_1716357501848",
"timestamp": 1716357539861,
"payload": {
"responseCode": "FDFJD0000",
"responseMessage": "Feedjob Deleted",
"timeStamp": "1716357539859"
},
"collectionId": "1",
"eventType": "feedservice/feedjob/delete",
"userId": "111",
"actOnBehalfOfUser": 0,
"roles": [
"ROLE_FEED_ADMIN"
],
"channel": "CSR"
}
}DeleteFeed
Event Type: feedservice/feed/delete
{
"version": "0",
"id": "29f0a43e-8537-7948-7cb3-51ce12087cb4",
"detail-type": "feedservice/feed/delete",
"source": "feedservice",
"account": "277827593990",
"time": "2024-05-22T05:58:37Z",
"region": "us-east-1",
"resources": [
],
"detail": {
"id": "catalogImport_1716357517814",
"timestamp": 1716357517870,
"payload": {
"responseCode": "FDFDD0000",
"responseMessage": "Feed Deleted",
"timeStamp": "1716357517868"
},
"eventType": "feedservice/feed/delete",
"userId": "111",
"actOnBehalfOfUser": 0,
"roles": [
"ROLE_FEED_ADMIN"
],
"channel": "CSR"
}
}DeleteSchedule
Event Type: feedservice/schedule/delete
{
"version": "0",
"id": "c3edfbe3-a639-83fc-2cb0-689582fd3fee",
"detail-type": "feedservice/schedule/delete",
"source": "feedservice",
"account": "277827593990",
"time": "2024-05-22T05:59:20Z",
"region": "us-east-1",
"resources": [
],
"detail": {
"id": "catalogImport_1716357501848",
"timestamp": 1716357560880,
"payload": {
"scheduleId": "ScheduleId_1716357560808",
"businessId": 1,
"collectionId": "1",
"feedId": "catalogImport_1716357501848",
"jobId": "1716357523096_catalogimport",
"startTime": "2024-05-22T05:59:20.873503977",
"createdBy": 0,
"updatedBy": 0
},
"collectionId": "1",
"eventType": "feedservice/schedule/delete",
"userId": "111",
"actOnBehalfOfUser": 0,
"roles": [
"ROLE_FEED_ADMIN"
],
"channel": "CSR"
}
}PatchUpdateFeedJob
Event Type: feedservice/feedjob/patch
{
"version": "0",
"id": "0bb70168-8110-9265-d6b1-e1184012fad0",
"detail-type": "feedservice/feedjob/patch",
"source": "feedservice",
"account": "277827593990",
"time": "2024-05-22T05:58:53Z",
"region": "us-east-1",
"resources": [
],
"detail": {
"id": "catalogImport_1716357501848",
"timestamp": 1716357533593,
"payload": {
"feedId": "catalogImport_1716357501848",
"jobId": "1716357523096_catalogimport",
"businessId": 1,
"collectionId": "1",
"serviceType": "catalog",
"name": "Catalog",
"description": "catalogImport",
"status": "ACTIVE",
"jobParams": [
{
"name": "string",
"stringValue": "string"
}
],
"createdOn": "2024-05-22T05:58:43.115",
"createdBy": 111,
"updatedOn": "2024-05-22T05:58:53.582345363",
"updatedBy": 111,
"executionType": "SPRINGBATCH"
},
"collectionId": "1",
"eventType": "feedservice/feedjob/patch",
"userId": "111",
"actOnBehalfOfUser": 0,
"roles": [
"ROLE_FEED_ADMIN"
],
"channel": "CSR"
}
}PatchUpdateFeed
Event Type: feedservice/feed/patch
{
"version": "0",
"id": "62b2d851-5a0c-9f9c-ff5a-4a4845060b00",
"detail-type": "feedservice/feed/patch",
"source": "feedservice",
"account": "277827593990",
"time": "2024-05-22T05:58:27Z",
"region": "us-east-1",
"resources": [
],
"detail": {
"id": "catalogImport_1716357507265",
"timestamp": 1716357507338,
"payload": {
"feedId": "catalogImport_1716357507265",
"serviceType": "catalog",
"serviceConfigs": [
"string"
],
"name": "catalogImport_1716357507265",
"description": "string",
"jobInfo": {
"jobId": "string",
"jobPath": "/skava-pedev/catalog/import/job/catalogImport_1716357507265",
"jobParams": [
"string"
],
"scheduleParams": [
"string"
]
},
"allowParllelExecution": false,
"executionCluster": "string",
"createdOn": "2024-05-22T05:58:27.283",
"createdBy": 0,
"updatedOn": "2024-05-22T05:58:27.334386974",
"updatedBy": 0,
"executionType": "PENTAHO",
"maxRunTime": 1800
},
"eventType": "feedservice/feed/patch",
"userId": "111",
"actOnBehalfOfUser": 0,
"roles": [
"ROLE_FEED_ADMIN"
],
"channel": "CSR"
}
}PatchUpdateSchedule
Event Type: feedservice/schedule/patch
{
"version": "0",
"id": "7fb71db3-5668-82fc-9528-ed2f88b28d00",
"detail-type": "feedservice/schedule/patch",
"source": "feedservice",
"account": "277827593990",
"time": "2024-05-22T05:59:15Z",
"region": "us-east-1",
"resources": [
],
"detail": {
"id": "ScheduleId_1716357555554",
"timestamp": 1716357555640,
"payload": {
"scheduleId": "ScheduleId_1716357555554",
"businessId": 1,
"collectionId": "1",
"feedId": "catalogImport_1716357501848",
"jobId": "1716357523096_catalogimport",
"name": "string",
"description": "Patch updated",
"status": "INACTIVE",
"state": "WAITING",
"repeatInterval": 0,
"feedInterval": 0,
"maxRunTime": 0,
"startTime": "2023-05-05T07:56:47.771360",
"endTime": "2023-05-05T07:58:47.771360",
"params": [
{
"name": "string",
"stringValue": "string"
}
],
"createdOn": "2024-05-22T05:59:15.568",
"createdBy": 111,
"updatedOn": "2024-05-22T05:59:15.635525599",
"updatedBy": 111,
"serviceType": "catalog"
},
"collectionId": "1",
"eventType": "feedservice/schedule/patch",
"userId": "111",
"actOnBehalfOfUser": 0,
"roles": [
"ROLE_FEED_ADMIN"
],
"channel": "CSR"
}
}UpdateFeedJob
Event Type: feedservice/feedjob/update
{
"version": "0",
"id": "4951663b-bbc5-5ce7-793e-987ca0b13610",
"detail-type": "feedservice/feedjob/update",
"source": "feedservice",
"account": "277827593990",
"time": "2024-05-22T05:58:48Z",
"region": "us-east-1",
"resources": [
],
"detail": {
"id": "catalogImport_1716357501848",
"timestamp": 1716357528348,
"payload": {
"feedId": "catalogImport_1716357501848",
"jobId": "1716357523096_catalogimport",
"businessId": 1,
"collectionId": "1",
"serviceType": "catalog",
"name": "Catalog",
"description": "catalogImport",
"status": "ACTIVE",
"jobParams": [
{
"name": "string",
"stringValue": "string"
}
],
"createdOn": "2024-05-22T05:58:43.115",
"createdBy": 111,
"updatedOn": "2024-05-22T05:58:48.337682568",
"updatedBy": 111,
"executionType": "PENTAHO"
},
"collectionId": "1",
"eventType": "feedservice/feedjob/update",
"userId": "111",
"actOnBehalfOfUser": 0,
"roles": [
"ROLE_FEED_ADMIN"
],
"channel": "CSR"
}
}UpdateFeed
Event Type: feedservice/feed/update
{
"version": "0",
"id": "5ea57c2a-2612-baa9-8dec-adb0b2b84492",
"detail-type": "feedservice/feed/update",
"source": "feedservice",
"account": "277827593990",
"time": "2024-05-22T05:58:32Z",
"region": "us-east-1",
"resources": [
],
"detail": {
"id": "catalogImport_1716357512522",
"timestamp": 1716357512586,
"payload": {
"feedId": "catalogImport_1716357512522",
"serviceType": "oms",
"serviceConfigs": [
"string"
],
"name": "CatalogImport",
"description": "catalogImport",
"jobInfo": {
"jobId": "string",
"jobPath": "string",
"jobParams": [
"string"
],
"scheduleParams": [
"string"
]
},
"allowParllelExecution": false,
"executionCluster": "string",
"createdOn": "2024-05-22T05:58:32.536",
"createdBy": 0,
"updatedOn": "2024-05-22T05:58:32.581898359",
"updatedBy": 0,
"executionType": "SPRINGBATCH"
},
"eventType": "feedservice/feed/update",
"userId": "111",
"actOnBehalfOfUser": 0,
"roles": [
"ROLE_FEED_ADMIN"
],
"channel": "CSR"
}
}UpdateSchedule
Event Type: feedservice/schedule/update
{
"version": "0",
"id": "707eee53-e6d7-a563-ad55-b44118830e35",
"detail-type": "feedservice/schedule/update",
"source": "feedservice",
"account": "277827593990",
"time": "2024-05-22T05:59:10Z",
"region": "us-east-1",
"resources": [
],
"detail": {
"id": "ScheduleId_1716357550304",
"timestamp": 1716357550393,
"payload": {
"scheduleId": "ScheduleId_1716357550304",
"businessId": 1,
"collectionId": "1",
"feedId": "catalogImport_1716357501848",
"jobId": "1716357523096_catalogimport",
"name": "string",
"description": "updated",
"status": "INACTIVE",
"state": "WAITING",
"repeatInterval": 0,
"feedInterval": 0,
"maxRunTime": 0,
"startTime": "2023-05-05T07:56:47.771360",
"endTime": "2023-05-05T07:58:47.771360",
"params": [
{
"name": "string",
"stringValue": "string"
}
],
"createdOn": "2024-05-22T05:59:10.324",
"createdBy": 111,
"updatedOn": "2024-05-22T05:59:10.388653845",
"updatedBy": 111,
"serviceType": "catalog"
},
"collectionId": "1",
"eventType": "feedservice/schedule/update",
"userId": "111",
"actOnBehalfOfUser": 0,
"roles": [
"ROLE_FEED_ADMIN"
],
"channel": "CSR"
}
}Internal Events via RabbitMQ/AWS MQ
The following events communicate with the internal microservices.
List of Events
| SL.# | Name | Description | Publish Location | Routing Key | Durability | Payload Type |
|---|---|---|---|---|---|---|
| 1 | Feed Start Event | This event is triggered when the feed is started. | Topic: ecomm | feed.schedule.start.catalog.catalogimport.*.# | false | FeedStartEvent |
| 2 | Feed End Event | This event is triggered when the feed is ended. | Topic: ecomm | feed.schedule.end.catalog.catalogimport.*.# | false | FeedEndEvent |
Payload Models
Below are the payloads for the Feeds microservice events.
FeedStartEvent
| Property | Type | Description | Example |
|---|---|---|---|
collectionId | Long | Indicates the ID of the collection. | 1 |
scheduleId | String | Indicates the ID of the feed schedule. | schedule_catalog_import |
feedId | String | Indicates the ID of the feed. | catalogimport |
jobId | String | Indicates the ID of the feed job. | 1_catalogimport |
serviceType | String | Specifies the type of service, such as catalog, pricing, inventory, etc. | catalog |
params | JSONArray | Holds the parameters of the feed schedule. | [{"name":"collectionId","stringValue":"1"},{"name":"catalogId","stringValue":"master"}] |
status | enum | Indicates the status of the feed, such as COMPLETE, ERROR, RUNNING, and UNKNOWN. | RUNNING |
summary | JSONObject | Indicates the summary report of the feed, which contains create, update, and failed count and reason. | null |
FeedEndEvent
| Property | Type | Description | Example |
|---|---|---|---|
collectionId | Long | Indicates the ID of the collection. | 1 |
scheduleId | String | Indicates the ID of the feed schedule. | schedule_catalog_import |
feedId | String | Indicates the ID of the feed. | catalogimport |
jobId | String | Indicates the ID of the feed job. | 1_catalogimport |
serviceType | String | Specifies the type of service, such as catalog, pricing, inventory, etc. | catalog |
params | JSONArray | Holds the parameters of the feed schedule. | [{"name":"collectionId","stringValue":"1"},{"name":"catalogId","stringValue":"master"}] |
status | enum | Indicates the status of the feed, such as COMPLETE, ERROR, RUNNING, and UNKNOWN. | COMPLETE |
summary | JSONObject | Indicates the summary report of the feed, which contains create, update, and failed count and reason. | {\"attribute\":{\"created\":200,\"updated\":7,\"failed\":1,\"failed_reason\":[{\"identifier\":\"producttype\",\"reason\":\"Custom attribute cannot be updated : producttype\",\"Rows\":{\"0\":\"producttype\",\"1\":\"Static\",\"2\":\"False\",\"3\":\"Enummultiselect\",\"4\":\"False\",\"5\":\"False\",\"6\":\"False\",\"7\":\"Active\",\"8\":\"2018-06-15T13:45:30\",\"9\":\"2025-06-15T13:45:30\",\"10\":\"ProductType\",\"11\":\"collection,bundle\"}}]},\"product\":{\"created\":125,\"updated\":1,\"failed\":0,\"failed_reason\":[]},\"sku\":{\"created\":8,\"updated\":5,\"failed\":0,\"failed_reason\":[]}} |
Revision History
2024-05-24 | AN – Added external events for 8.17.4 release.
2019-06-08 | PLK – Minor copyedits.
2019-05-10 | AN – Minor copyedits.
2019-04-08 | AN – Content updated for April 2019 release.
2019-01-21 | PLK – Page added.
