Skip to content
  • There are no suggestions because the search field is empty.

Webhook event reference

Supported event types and payload examples for MAPI

 

Overview

Product updates    Catalog/category updates    Asset updates    Other updates


Overview

This article provides a comprehensive list of event types supported by Bluestone PIM webhooks.

Related documentation:

Please see the following sections on event types currently supported. Click the relevant type to view an example.

Product updates

Product created
Product name changed
Product number changed
Product description changed
Product status changed
Product category changed
Product assets changed
Product relation changed
Product label changed

ATTRIBUTES:
Attribute assigned to product
Attribute unassigned from product
Attribute value changed on product

VARIANT GROUPS AND BUNDLES:
Product added or removed from variant group
Product added or removed from bundle
Product quantity in bundle changed

Catalog/category updates

Catalog/category added
Catalog/category name changed
Catalog/category number changed
Catalog/category description changed
Catalog/category asset changed
Category moved to different parent category
Category reordered within parent catalog
Category deleted
Catalog archived

ATTRIBUTES:
Attribute assigned to catalog/category
Attribute unassigned from catalog/category
Attribute value changed on catalog/category
Category level attribute (CLA) value changed

Asset updates

Asset added
Asset name changed
Asset number changed
Asset description changed

ATTRIBUTES:
Attribute assigned to asset
Attribute unassigned from asset
Attribute value changed on asset

Other updates

New sync done to Public API


Description: New product created
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: Name has changed on product
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
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
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: Status has changed on product
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: Changes for category on product
Event type: PRODUCT_WATCH_CATEGORY

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


Description: Change on product asset
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: Change for relation on product
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 for label on product
Event type: PRODUCT_WATCH_LABEL

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


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"
        }
      }
    }
  ]
}


Description: Attribute value changed on product
Event type: PRODUCT_WATCH_ATTRIBUTE_UPDATE_VALUE

In these examples, there are three contexts in the organization:

  • en (default)
  • no (uses "en" as fallback)
  • pl (does not use a fallback)

When a change is done for a global attribute in context "en":

{
  "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",
          "contextId": null,
          "affectedContextIds": ["en","no","pl"]
        }
      }
    }
  ]
}

When a change is done for a context-specific attribute in "en":

{
  "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",
          "contextId": "en",
          "affectedContextIds": ["en","no"]
        }
      }
    }
  ]
}

When a change is done for a context-specific attribute in "pl":

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


Description: Product added or removed from variant group
Event type: PRODUCT_WATCH_VARIANT

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


Description: Product added or removed from bundle
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
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: New catalog/category added
Event type: CATEGORY_CREATED

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


Description: Change of catalog/category name
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
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
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: Change on category asset
Event type: CATEGORY_WATCH_ASSET

{
  "timestamp": 1776078118881,
  "events": [
    {
      "changes": {
        "eventType": "CATEGORY_WATCH_ASSET",
        "entityIds": [
          "65a10e0fe231de04c839d0ed"
        ],
        "assetChange": {
          "changeType": "ASSOCIATE",
          "assetId": "dbf93927-1f86-4baf-b99f-31fa9fbec903"
        }
      }
    }
  ]
}


Description: Category moved to different parent category
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
Event type: CATEGORY_WATCH_ORDER

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


Description: Category removed
Event type: CATEGORY_REMOVED

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


Description: Catalog archived
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: Attribute assigned to catalog/category
Event type: CATEGORY_LOCAL_WATCH_ATTRIBUTE_ASSOCIATION

{
  "timestamp": 1776080337308,
  "events": [
    {
      "changes": {
        "eventType": "CATEGORY_LOCAL_WATCH_ATTRIBUTE_ASSOCIATION",
        "entityIds": [
          "65a10e0fe231de04c839d0ed"
        ],
        "attributeChange": {
          "changeType": "ASSOCIATE",
          "attributeType": "text",
          "attributeId": "69b02f95cfa347c3b5786df9",
          "attributeOldValue": null,
          "attributeNewValue": null,
          "context": "en",
          "contextId": null,
          "affectedContextIds": [
            "l3877",
            "l3888",
            "en"
          ]
        }
      }
    }
  ]
}


Description: Attribute unassigned from catalog/category
Event type: CATEGORY_LOCAL_WATCH_ATTRIBUTE_DISASSOCIATION

{
  "timestamp": 1776080461932,
  "events": [
    {
      "changes": {
        "eventType": "CATEGORY_LOCAL_WATCH_ATTRIBUTE_DISASSOCIATION",
        "entityIds": [
          "65a10e0fe231de04c839d0ed"
        ],
        "attributeChange": {
          "changeType": "DISASSOCIATE",
          "attributeType": "text",
          "attributeId": "69b02f95cfa347c3b5786df9",
          "attributeOldValue": null,
          "attributeNewValue": null,
          "context": "en",
          "contextId": null,
          "affectedContextIds": [
            "l3877",
            "l3888",
            "en"
          ]
        }
      }
    }
  ]
}


Description: Attribute value changed on catalog/category
Event type: CATEGORY_LOCAL_WATCH_ATTRIBUTE_UPDATE_VALUE

{
  "timestamp": 1776080655335,
  "events": [
    {
      "changes": {
        "eventType": "CATEGORY_LOCAL_WATCH_ATTRIBUTE_UPDATE_VALUE",
        "entityIds": [
          "65a10e0fe231de04c839d0ed"
        ],
        "attributeChange": {
          "changeType": "UPDATE",
          "attributeType": "formatted_text",
          "attributeId": "65a10dddb2ca8f533771493f",
          "attributeOldValue": null,
          "attributeNewValue": "category attribute value test",
          "context": "en",
          "contextId": "en",
          "affectedContextIds": [
            "l3877",
            "en"
          ]
        }
      }
    }
  ]
}


Description: Change of value in category level attribute (CLA)
Event type: CATEGORY_WATCH_ATTRIBUTE

In these examples, there are three contexts in the organization: 

  • en (default)
  • no (uses "en" as fallback)
  • pl (does not use a fallback)

When a change is done for a global attribute in context "en":

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

When a change is done for a context-specific attribute in context "en":

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

When a change is done for a context-specific attribute in context "pl":

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


Description: Asset added to the DAM
Event type: ASSET_CREATED

{
  "timestamp": 1776081044169,
  "events": [
    {
      "changes": {
        "eventType": "ASSET_CREATED",
        "entityIds": [
          "8ae2a76a-5a8a-4210-98a3-ab19b99cc420"
        ],
        "metadataChanges": [
          {
            "field": "NAME",
            "oldValue": null,
            "newValue": "Bluestone logo blue",
            "context": "en"
          },
          {
            "field": "NUMBER",
            "oldValue": null,
            "newValue": "8ae2a76a-5a8a-4210-98a3-ab19b99cc420",
            "context": "en"
          },
          {
            "field": "MEDIA_TYPE",
            "oldValue": null,
            "newValue": "IMAGE",
            "context": "en"
          }
        ]
      }
    }
  ]
}


Description: Asset name changed
Event type: ASSET_WATCH_METADATA_NAME

{
  "timestamp": 1776081166203,
  "events": [
    {
      "changes": {
        "eventType": "ASSET_WATCH_METADATA_NAME",
        "entityIds": [
          "8ae2a76a-5a8a-4210-98a3-ab19b99cc420"
        ],
        "nameChange": {
          "changeType": "UPDATE",
          "oldValue": null,
          "newValue": "Bluestone logo blue original",
          "context": "en"
        }
      }
    }
  ]
}

Description: Asset number changed
Event type: ASSET_WATCH_METADATA_NUMBER

{
  "timestamp": 1776083179889,
  "events": [
    {
      "changes": {
        "eventType": "ASSET_WATCH_METADATA_NUMBER",
        "entityIds": [
          "8ae2a76a-5a8a-4210-98a3-ab19b99cc420"
        ],
        "numberChange": {
          "changeType": "UPDATE",
          "oldValue": null,
          "newValue": "new_number"
        }
      }
    }
  ]
}

Description: Asset description changed
Event type: ASSET_WATCH_METADATA_DESCRIPTION

{
  "timestamp": 1776081288251,
  "events": [
    {
      "changes": {
        "eventType": "ASSET_WATCH_METADATA_DESCRIPTION",
        "entityIds": [
          "8ae2a76a-5a8a-4210-98a3-ab19b99cc420"
        ],
        "descriptionChange": {
          "changeType": "UPDATE",
          "oldValue": null,
          "newValue": "Asset description",
          "context": "en"
        }
      }
    }
  ]
}


Description: Attribute assigned to asset
Event type: ASSET_WATCH_ATTRIBUTE_ASSOCIATION

{
  "timestamp": 1776081471282,
  "events": [
    {
      "changes": {
        "eventType": "ASSET_WATCH_ATTRIBUTE_ASSOCIATION",
        "entityIds": [
          "8ae2a76a-5a8a-4210-98a3-ab19b99cc420"
        ],
        "attributeAssociate": {
          "attributeId": "65a10dde845d81587b8186ba"
        }
      }
    }
  ]
}

Description: Attribute unassigned from asset
Event type: ASSET_WATCH_ATTRIBUTE_DISASSOCIATION

{
  "timestamp": 1776081593371,
  "events": [
    {
      "changes": {
        "eventType": "ASSET_WATCH_ATTRIBUTE_DISASSOCIATION",
        "entityIds": [
          "8ae2a76a-5a8a-4210-98a3-ab19b99cc420"
        ],
        "attributeDisassociate": {
          "attributeId": "65a10dde845d81587b8186ba"
        }
      }
    }
  ]
}

Description: Attribute value changed on asset
Event type: ASSET_WATCH_ATTRIBUTE_UPDATE_VALUE

{
  "timestamp": 1776081532301,
  "events": [
    {
      "changes": {
        "eventType": "ASSET_WATCH_ATTRIBUTE_UPDATE_VALUE",
        "entityIds": [
          "8ae2a76a-5a8a-4210-98a3-ab19b99cc420"
        ],
        "attributeChange": {
          "changeType": "UPDATE",
          "attributeType": "DATE",
          "attributeId": "65a10ddcb8cad5036ca6be90",
          "attributeOldValue": null,
          "attributeNewValue": "2026-07-31",
          "context": "en",
          "contextId": "en",
          "affectedContextIds": [
            "l3877",
            "en"
          ]
        }
      }
    }
  ]
}


Description: New sync done to the 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"
        }
      }
    }
  ]
}

 

Back to the top