Webhook event types

List of event types for webhooks in MAPI with examples.

For documentation about working with events in general, see this page.

Here is a list of event types supported in Bluestone PIM:

  1. Change on product assets in PIM
  2. Product added or removed from bundle in PIM
  3. Change of product quantity in bundle in PIM
  4. Changes for category on product in PIM
  5. Change for label on product in PIM
  6. Name has changed on product in PIM
  7. Number has changed on product in PIM
  8. Description has changed on product in PIM
  9. Changes for relations on product in PIM
  10. Change on product state in PIM
  11. Product added or removed from variant in PIM
  12. New product of any type created in PIM
  13. New sync done to Public API
  14. Change of catalog/category name in PIM
  15. Change of catalog/category number in PIM
  16. Change of catalog/category description in PIM
  17. Catalog archived in PIM
  18. Category moved to different parent category in PIM
  19. Category reordered within parent catalog in PIM
  20. Change of value in category level attribute in PIM
  21. New catalog/category added in PIM
  22. Category removed from PIM
  23. Attribute value changed on product
  24. Attribute assigned to product
  25. Attribute unassigned from product



Description:
Change on product assets in PIM
Event type: PRODUCT_WATCH_ASSET

{
"timestamp": 1698151710541,
"events": [
{
"changes": {
"eventType": "PRODUCT_WATCH_ASSET",
"entityIds": [
"641314b6ee358800012b279b"
],
"assetChange": {
"changeType": "ASSOCIATE",
"assetId": "4e573584-f7fe-45d4-9ffb-0a44e3c0f11f"
}
}
}
]
}



Description:
Product added or removed from bundle in PIM
Event type: PRODUCT_WATCH_BUNDLE

{
"timestamp": 1698151870922,
"events": [
{
"changes": {
"eventType": "PRODUCT_WATCH_BUNDLE",
"entityIds": [
"6322cea64cedfd0001333366"
],
"bundleChange": {
"changeType": "ASSOCIATE",
"bundleId": "65030e004bc6e505b4bdc785"
}
}
}
]
}



Description:
Change of product quantity in bundle in PIM
Event type: PRODUCT_WATCH_BUNDLE_QUANTITY

{
"timestamp": 1698220726070,
"events": [
{
"changes": {
"eventType": "PRODUCT_WATCH_BUNDLE_QUANTITY",
"entityIds": [
"6322cea64cedfd0001333366"
],
"bundleQuantityChange": {
"changeType": "UPDATE",
"oldValue": "1",
"newValue": "2"
}
}
}
]
}



Description:
Changes for category on product in PIM
Event type: PRODUCT_WATCH_CATEGORY

{
"timestamp": 1698151781966,
"events": [
{
"changes": {
"eventType": "PRODUCT_WATCH_CATEGORY",
"entityIds": [
"641314b6ee358800012b279b"
],
"categoryChange": {
"changeType": "ASSOCIATE",
"categoryId": "633d6809d6018000014074a2"
}
}
}
]
}



Description:
Change for label on product in PIM
Event type: PRODUCT_WATCH_LABEL

{
"timestamp": 1698151751786,
"events": [
{
"changes": {
"eventType": "PRODUCT_WATCH_LABEL",
"entityIds": [
"641314b6ee358800012b279b"
],
"labelChange": {
"changeType": "ASSOCIATE",
"labelId": "62692d29713c0900014eeacf"
}
}
}
]
}



Description:
Name has changed on product in PIM
Event type: PRODUCT_WATCH_METADATA_NAME

{
"timestamp": 1698220960207,
"events": [
{
"changes": {
"eventType": "PRODUCT_WATCH_METADATA_NAME",
"entityIds": [
"6537bdebb388e74a0482e761"
],
"nameChange": {
"type": "UPDATE",
"oldValue": "Product A",
"newValue": "Product B",
"context": "en"
}
}
}
]
}



Description:
Number has changed on product in PIM
Event type: PRODUCT_WATCH_METADATA_NUMBER

{
"timestamp": 1698221525385,
"events": [
{
"changes": {
"eventType": "PRODUCT_WATCH_METADATA_NUMBER",
"entityIds": [
"6537bdebb388e74a0482e761"
],
"numberChange": {
"type": "UPDATE",
"oldValue": "product-a",
"newValue": "product-b"
}
}
}
]
}



Description:
Description has changed on product in PIM
Event type: PRODUCT_WATCH_METADATA_DESCRIPTION

{
"timestamp": 1698221665578,
"events": [
{
"changes": {
"eventType": "PRODUCT_WATCH_METADATA_DESCRIPTION",
"entityIds": [
"6537bdebb388e74a0482e761"
],
"descriptionChange": {
"type": "UPDATE",
"oldValue": null,
"newValue": "This is a description",
"context": "en"
}
}
}
]
}



Description:
Changes for relations on product in PIM
Event type: PRODUCT_WATCH_RELATION

{
"timestamp": 1698221848540,
"events": [
{
"changes": {
"eventType": "PRODUCT_WATCH_RELATION",
"entityIds": [
"6537bdebb388e74a0482e761"
],
"relationChange": {
"changeType": "ASSOCIATE",
"relationId": "5d9d817fd60180000cc2bb54",
"reverse": false,
"connectedProductId": "65030e004bc6e505b4bdc785"
}
}
}
]
}



Description:
Change on product state in PIM
Event type: PRODUCT_WATCH_STATE

{
"timestamp": 1698152021030,
"events": [
{
"changes": {
"eventType": "PRODUCT_WATCH_STATE",
"entityIds": [
"6537bdebb388e74a0482e761"
],
"stateChange": {
"changeType": "UPDATE",
"oldValue": null,
"newValue": "TO_BE_PUBLISHED",
"context": "en"
}
}
}
]
}



Description:
Product added or removed from variant in PIM
Event type: PRODUCT_WATCH_VARIANT

{
"timestamp": 1698151841673,
"events": [
{
"changes": {
"eventType": "PRODUCT_WATCH_VARIANT",
"entityIds": [
"6399dc225f15030001109d65"
],
"variantChange": {
"changeType": "ASSOCIATE",
"variantId": "65030e004bc6e505b4bdc785"
}
}
}
]
}



Description:
New product of any type created in PIM
Event type: PRODUCT_CREATED

{
"timestamp": 1698151920627,
"events": [
{
"changes": {
"eventType": "PRODUCT_CREATED",
"entityIds": [
"6537bdebb388e74a0482e761"
],
"metadataChanges": [
{
"field": "NAME",
"oldValue": null,
"newValue": "Product A",
"context": "en"
},
{
"field": "NUMBER",
"oldValue": null,
"newValue": "product-a",
"context": "en"
},
{
"field": "TYPE",
"oldValue": null,
"newValue": "SINGLE",
"context": "en"
}
]
}
}
]
}



Description:
New sync done to Public API
Event type: PRODUCT_SYNC_DONE

{
"timestamp": 1698152131200,
"events": [
{
"changes": {
"eventType": "PRODUCT_SYNC_DONE",
"entityIds": [],
"syncDoneData": {
"field": "PAPI_SYNC_ID",
"value": "6537bebdfbde8a0013911d23",
"context": "en"
}
}
}
]
}



Description:
Change of catalog/category name in PIM
Event type: CATEGORY_WATCH_METADATA_NAME

{
"timestamp": 1698221989114,
"events": [
{
"changes": {
"eventType": "CATEGORY_WATCH_METADATA_NAME",
"entityIds": [
"633d6824cff47e0001de8f9c"
],
"nameChange": {
"changeType": "UPDATE",
"oldValue": "Clothes",
"newValue": "Clothing",
"context": "en"
}
}
}
]
}



Description:
Change of catalog/category number in PIM
Event type: CATEGORY_WATCH_METADATA_NUMBER

{
"timestamp": 1698222106177,
"events": [
{
"changes": {
"eventType": "CATEGORY_WATCH_METADATA_NUMBER",
"entityIds": [
"633d6824cff47e0001de8f9c"
],
"numberChange": {
"changeType": "UPDATE",
"oldValue": "clothes",
"newValue": "clothing"
}
}
}
]
}



Description:
Change of catalog/category description in PIM
Event type: CATEGORY_WATCH_METADATA_DESCRIPTION

{
"timestamp": 1698222167257,
"events": [
{
"changes": {
"eventType": "CATEGORY_WATCH_METADATA_DESCRIPTION",
"entityIds": [
"633d6824cff47e0001de8f9c"
],
"descriptionChange": {
"changeType": "UPDATE",
"oldValue": null,
"newValue": "This is a category description",
"context": "en"
}
}
}
]
}



Description:
Catalog archived in PIM
Event type: CATEGORY_WATCH_ARCHIVE_STATE

{
"timestamp": 1698222212581,
"events": [
{
"changes": {
"eventType": "CATEGORY_WATCH_ARCHIVE_STATE",
"entityIds": [
"5f7326c2590801000cedf379",
"632d66b4cff47e0001798c2e",
"5f6df6b44cedfd000c98b19f"
],
"stateChange": {
"changeType": "UPDATE",
"oldValue": "ACTIVE",
"newValue": "ARCHIVED"
}
}
}
]
}



Description:
Category moved to different parent category in PIM
Event type: CATEGORY_WATCH_MOVE

{
"timestamp": 1698222447874,
"events": [
{
"changes": {
"eventType": "CATEGORY_WATCH_MOVE",
"entityIds": [
"5f6c75cc590801000cec9ff4"
],
"parentChange": {
"changeType": "UPDATE",
"oldValue": "5d78f9ba590801000cf00cbc",
"newValue": "5d78f92652faff000e53435a"
}
}
}
]
}



Description:
Category reordered within parent catalog in PIM
Event type: CATEGORY_WATCH_ORDER

{
"timestamp": 1698223283443,
"events": [
{
"changes": {
"eventType": "CATEGORY_WATCH_ORDER",
"entityIds": [
"5d78f916ee3588000c7686e5"
],
"orderChange": {
"changeType": "UPDATE",
"oldValue": "0",
"newValue": "1"
}
}
}
]
}



Description:
Change of value in category level attribute in PIM
Event type: CATEGORY_WATCH_ATTRIBUTE

{
"timestamp": 1698225240169,
"events": [
{
"changes": {
"eventType": "CATEGORY_WATCH_ATTRIBUTE",
"entityIds": [
"5d78f916ee3588000c7686e5"
],
"attributeChange": {
"changeType": "UPDATE",
"attributeType": "text",
"attributeId": "5da7254de21b84000c6ed075",
"attributeOldValue": "Red",
"attributeNewValue": "Blue",
"context": "en"
}
}
}
]
}



Description:
New catalog/category added in PIM
Event type: CATEGORY_CREATED

{
"timestamp": 1698225320204,
"events": [
{
"changes": {
"eventType": "CATEGORY_CREATED",
"entityIds": [
"6538dca57566616af2206608"
],
"name": "Shoes",
"number": "6538dca57566616af2206608",
"parentId": "633d67fed6018000014074a1"
}
}
]
}



Description:
Category removed from PIM
Event type: CATEGORY_REMOVED

{
"timestamp": 1698225360054,
"events": [
{
"changes": {
"eventType": "CATEGORY_REMOVED",
"entityIds": [
"6538dca57566616af2206608"
]
}
}
]
}



Description:
Attribute value changed on product
Event type: PRODUCT_WATCH_ATTRIBUTE_UPDATE_VALUE

{
"timestamp": 1698151295719,
"events": [
{
"changes": {
"eventType": "PRODUCT_WATCH_ATTRIBUTE_UPDATE_VALUE",
"entityIds": [
"641314b6ee358800012b279b"
],
"attributeChange": {
"changeType": "UPDATE",
"attributeType": "text",
"attributeId": "5da7254de21b84000c6ed075",
"attributeOldValue": "Red",
"attributeNewValue": "Blue",
"context": "en"
}
}
}
]
}



Description:
Attribute assigned to product
Event type: PRODUCT_WATCH_ATTRIBUTE_ASSOCIATION

{
"timestamp": 1698225395172,
"events": [
{
"changes": {
"eventType": "PRODUCT_WATCH_ATTRIBUTE_ASSOCIATION",
"entityIds": [
"6537bdebb388e74a0482e761"
],
"attributeAssociate": {
"changeType": "ASSOCIATE",
"attributeType": "text",
"attributeId": "5da7254de21b84000c6ed075",
"attributeOldValue": null,
"attributeNewValue": null,
"context": "en"
}
}
}
]
}



Description:
Attribute unassigned from product
Event type: PRODUCT_WATCH_ATTRIBUTE_DISASSOCIATION

{
"timestamp": 1698225731333,
"events": [
{
"changes": {
"eventType": "PRODUCT_WATCH_ATTRIBUTE_DISASSOCIATION",
"entityIds": [
"6537bdebb388e74a0482e761"
],
"attributeDisassociate": {
"attributeId": "5da7254de21b84000c6ed075"
}
}
}
]
}




Back to the top