Catalog Notifications via Webhooks

The system support 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.

Catalog Update Notifications

The system supports callbacks to Partners/Subscribers when changes to the catalog information have been made to the partner catalog. This allows the subscriber to receive a message when the information has changed.

The partner will be required to supply a public HTTPS endpoint and develop a Listener to receive the callback messages.

This notification service also provides an optional feature for subscriber to supply Open Authentication (OAuth) credentials as an additional layer of security.

As part of onboarding, please provide the answers of the below questionnaire, post which onboarding team will configure the credentials. Once configured, partner can conduct a validation test and share results.

What security mechanism would partner like to use for receiving notifications on this endpoint? GiftAPI support the below :
1. Basic (Username/Password)
2. OAuth (Client Credentials) 
3. API Key
What statuses would Partner like to be onboarded with? (Product Added, Product Update, Product Removed, Catalog Update)

The following tables consists the Events that partner can subscribe to :

Event type	Description
Product Added	One or more products were Added from the catalog.
Product Removed	One or more products were removed from the catalog.
Product Update	An existing product or its attribute details were updated in the catalog.
Catalog Update	The catalog was updated with a combination of product addition, removal, and/or update.

The following tables consists the detail of the Catalog Notifications:

Field	Why the Partner Needs to Know
status	If the product becomes inactive, discontinued, or its availability changes, partners must stop selling or adjust inventory.
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.
locale	To ensure localized product versions are shown in appropriate regions/languages.
locales	If locales are added/removed, partners must adapt to maintain accurate localization.
currency	For adjusting pricing and handling currency conversion in payment systems.
SKUs	To track product variants (e.g., sizes, colors), preventing inventory errors.
productId	To maintain correct product associations after rebranding/versioning.
images	To display current visuals across platforms and promotional materials.
createdDate	Helps partners manage product lifecycle and version control.
updatedDate	Triggers the need to refresh product info in partner systems.
isSecurityAccessCodeEnabled	A change in the security feature (like enabling security codes) might affect how the product is activated or redeemed, requiring partners to adapt systems for this change.
ProductType	A shift in product type (e.g., from a physical product to a digital one) may change how the product is distributed or supported by the partner (e.g., delivery methods).
terms and conditions	Legal updates or changes must be reflected in the partner’s environment.

Promotion:

Field	Why the Partner Needs to Know
id	Unique identifier for the promotion. Any change can break mappings, tracking, or reporting.
promoId	Often used for redemptions, tracking, or audit trails. A change impacts partner-side configurations.
target	Defines who the promotion applies to (e.g., user group, region). Changing this alters eligibility logic.
title	Displayed to users. Any change may require updates on partner’s UI, campaigns, or localization.
description	Provides the offer details. Changes may need re-communication or compliance review on partner’s side.
code	Redeemable or referral code. Any modification must be synced to avoid redemption failures.
value	Monetary or discount value. A change affects the benefit offered and may trigger approval workflows.
Max Budget	Defines the budget available for promotion
Promotion Active : T\|F	Defines the promotion's State. Changes may cause confusion or misuse if not communicated.
percentage of Budget utilized	Impacts campaign management. Helps partners track remaining budget and plan additional outreach.

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": {
    "changes": {
      "productEntityId:0XCQNQYACNAYR7RG2N8FSGRL8Z": {
        "entityId": "0XCQNQYACNAYR7RG2N8FSGRL8Z",
        "name": "Benihana eGift",
        "productId": "10012026020000239037",
        "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": {
    "changes": {
      },
      "productEntityId:A3MWGXCS55FT5C9FK2L5R071RW": {
        "entityId": "6SQPW88YRTARTDCMXDH0QBVC00",
        "productId": "10012026020000239009",
        "name": "HAPPY TEST MEENA Product VPLN $02_AIWGOX1V18MF",
        "productId": "10012026020000239037",
        "removed": true
      },
      "productEntityId:BXNAHQ5P0QPWTHR9Y08QDBR3B4": {
        "entityId": "BeeTestCatalog0217_NK5YN99Y0JJLK2F4YF0VP23Z98",
        "productId": "10012026020000239341",
        "name": "1Second_HAPPY TEST MEENA Product VPLN $90_FH5G557BS2OO",
        "productId": "100120260200002391234",
        "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": {
    "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"
          }
        }
      }
    }
  }