Catalog Notifications via Webhooks

The system supports real-time catalog update notifications to Partners/Subscribers when product-level attributes are updated. This enables subscribers to stay synchronized with the latest product information and make the necessary adjustments in their own systems—such as updating product listings, prices, inventory status, or display content.
To enable this capability:

Partner/Subscriber must provide a public HTTPS endpoint
Partner/Subscriber must implement a Listener to receive and process the callback messages
Partner/Subscriber must confirm
- If security mechanism is required and if yes, which option to set up
  - API Key (recommended)
  - Basic
  - OAuth

The following table lists the change types included in the Catalog Update event:

CHANGE TYPES	Description
Added	One or more products were added from the catalog.
Removed	One or more products were removed from the catalog.
Updated	An existing product or its attribute details were updated in the catalog.

The following tables consists the update detail of the Catalog Notifications:

Field	Why the Partner Needs to Know
name	To update marketing and sales materials, preventing customer confusion and order errors.
description	To reflect new features, usage info, or correct errors on product pages.
termsAndConditions	Legal updates or changes must be reflected in the partner’s environment.
instructions	instructionType, instructionText
pricing.denomination	minAmount, maxAmount
productLine	name, description, logoImage
locales	If locales are updated, partners must adapt to maintain accurate localization.
SKUs	To track product variants (e.g., sizes, colors), preventing inventory errors. name, frontImage, imageSize
name	To update marketing and sales materials, preventing customer confusion and order errors.
description	To reflect new features, usage info, or correct errors on product pages.
termsAndConditions	Legal updates or changes must be reflected in the partner’s environment.
instructions	instructionType, instructionText
pricing.denomination	minAmount, maxAmount
productLine	name, description, logoImage
locales	If locales are updated, partners must adapt to maintain accurate localization.
SKUs	To track product variants (e.g., sizes, colors), preventing inventory errors. name, frontImage, imageSize

Promotion:

Field	Why the Partner Needs to Know
name	Name of the promotion
isActive	Indicates whether the promotion is active or scheduled (true) versus expired or inactive (false)
startDate	Promotion start date and time, expressed in UTC
expirationDate	Promotion end date and time in UTC; null when the promotion has no end date
promoCode	Code associated with the promotion and entered or applied at checkout; codes are unique and uppercase
promotionEffect	Type of benefit delivered by the promotion: DISCOUNT, BOGO, VALUE_ADD, or SHIPPING
description	Full descriptive text explaining the promotion
discountType	Specifies whether the discount is fixed-amount (FIXED) or percentage-based (PERCENTAGE)
percentOff	Percentage discount value; populated when discountType is PERCENTAGE.
amountOff	Fixed discount amount; populated when discountType is FIXED.
discountEffect	Indicates where the discount is applied: APPLY_TO_ORDER, APPLY_TO_ITEMS, or APPLY_TO_ITEMS_BY_QUANTITY.
termsAndConditions	Terms and conditions governing the promotion.
totalBudgetAmount	Total monetary budget allocated and available for the promotion.
minimumCardValue	Minimum card load/value eligible for the promotion.
maximumCardValue	Maximum card load/value eligible for the promotion.
maximumDiscountAmount	Maximum discount value permitted for the promotion, applicable to percentage discounts.
isBudgetExhausted	Indicates whether budget remains available for redemption: true means exhausted; false means budget remains.
isRedemptionLimitReached	Indicates whether the promotion’s redemption limit has been reached: true means no redemption capacity remains; false means capacity remains.

Catalog Payload Samples

{
    "header":
    {
        "eventId": "9e0a7fd4-6887-4960-89fd-11b44d8dfe71",
        "source": "cataloghub-bee",
        "timestamp": "2026-02-20 00:48:42",
        "eventType": "CATALOG_UPDATE",
        "tenantId": "BeeTestTenant0217",
        "catalogId": "BeeTestCatalog0217"
    },
    "content":
    {
        "catalogId": "BeeTestCatalog0217",
        "changes":
        {
            "productEntityId:0XCQNQYACNAYR7RG2N8FSGRL8Z":
            {
                "entityId": "0XCQNQYACNAYR7RG2N8FSGRL8Z",
                "name": "Benihana eGift",
                "added": true
            }
        }
    }
}

{
    "header":
    {
        "eventId": "9e0a7fd4-6887-4960-89fd-11b44d8dfe71",
        "source": "cataloghub-bee",
        "timestamp": "2026-02-20 00:48:42",
        "eventType": "CATALOG_UPDATE",
        "tenantId": "BeeTestTenant0217",
        "catalogId": "BeeTestCatalog0217"
    },
    "content":
    {
        "catalogId": "BeeTestCatalog0217",
        "changes":
        {
            "productEntityId:A3MWGXCS55FT5C9FK2L5R071RW":
            {
                "entityId": "6SQPW88YRTARTDCMXDH0QBVC00",
                "name": "HAPPY TEST MEENA Product VPLN $02_AIWGOX1V18MF",
                "removed": true
            },
            "productEntityId:BXNAHQ5P0QPWTHR9Y08QDBR3B4":
            {
                "entityId": "BeeTestCatalog0217_NK5YN99Y0JJLK2F4YF0VP23Z98",
                "name": "1Second_HAPPY TEST MEENA Product VPLN $90_FH5G557BS2OO",
                "removed": true
            }
        }
    }
}

{
    "header":
    {
        "eventId": "4efda9b5-b7d6-4518-92ab-930ca62f35ed",
        "source": "catalog",
        "timestamp": "2026-02-22 00:28:08",
        "eventType": "CATALOG_UPDATE",
        "tenantId": "TestTenant0217",
        "catalogId": "TestTenant0217"
    },
    "content":
    {
        "catalogId": "TestTenant0217",
        "changes":
        {
            "productEntityId:A3MWGXCS55FT5C9FK2L5R071RW:skuEntityId:XN4XBN2V4DAK4XHS6MFL3P86ZM":
            {
                "entityId": "XN4XBN2V4DAK4XHS6MFL3P86ZM",
                "productId": "10012026020000239037",
                "name": "Variant_HAPPY TEST MEENA Product VPLN $72_6IQIGWT2NCZ3123testV",
                "updated":
                {
                    "name":
                    {
                        "old": "Variant_HAPPY TEST MEENA Product VPLN $72_6IQIGWT2NCZ3M",
                        "new": "Variant_HAPPY TEST MEENA Product VPLN $72_6IQIGWT2NCZ3123testV"
                    }
                }
            },
            "productEntityId:0XCQNQYACNAYR7RG2N8FSGRL8Z":
            {
                "entityId": "0XCQNQYACNAYR7RG2N8FSGRL8Z",
                "name": "Benihana eGift",
                "updated":
                {
                    "termsAndConditions":
                    {
                        "old": "Usable up to balance only to buy goods or services at Benihana restaurants in the continental U.S. and Alaska only. Not valid in Hawaii. For participating locations, visit www.benihana.com.   Treat this card like cash; no replacement if lost/stolen. Not reloadable; no cash redemption. Funds don’t expire; if Valid Thru date has passed, call for new card. For balance inquiry/customer service, call 866-294-6806. Card issued by Pathward, Member FDIC. Test",
                        "new": "Usable up to balance only to buy goods or services at Benihana restaurants in the continental U.S. and Alaska only. Not valid in Hawaii. For participating locations, visit www.benihana.com.   Treat this card like cash; no replacement if lost/stolen. Not reloadable; no cash redemption. Funds don’t expire; if Valid Thru date has passed, call for new card. For balance inquiry/customer service, call 866-294-6806. Card issued by Pathward, Member FDIC. test---2---v"
                    }
                }
            }
        }
    }
}