catalog/updated

Overview

Property	Value
Webhook type	catalog/updated
Kafka topic	catalog.updated
Direction	Platform → Your endpoint

Description

Fired when any field on an existing catalog is updated. This includes metadata changes (title, description) and status transitions (e.g., activating a catalog or archiving it).

Trigger Conditions

• A user or integration updates catalog fields via the API
• The catalog status changes (e.g., DRAFT → ACTIVE, ACTIVE → DISABLED)

Message Envelope

{
  "header": {
    "organizationId": "org_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "messageId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "webhookId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "type": "catalog/updated",
    "date": "2024-03-10T14:00:00.000Z"
  },
  "body": { ... }
}

Body — Property Table

Catalog Object

Field	Type	Nullable	Description
id	string (uuid)	No	Unique catalog identifier
organizationId	string (uuid)	No	Organization that owns this catalog
name	string	No	Internal unique name (immutable)
title	string	No	Human-readable display name
description	string	Yes	Optional description
status	enum	No	Catalog status: DRAFT, ACTIVE, DISABLED, ARCHIVED
createdAt	string (ISO 8601)	No	Original creation timestamp
updatedAt	string (ISO 8601)	No	Timestamp of this update

Full JSON Payload Sample

{
  "header": {
    "organizationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "messageId": "b9c0d1e2-f3a4-5678-bcde-901234567890",
    "webhookId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "type": "catalog/updated",
    "date": "2024-03-10T14:00:00.000Z"
  },
  "body": {
    "id": "a8b9c0d1-e2f3-4567-abcd-890123456789",
    "organizationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "main-catalog-fr",
    "title": "Catalogue Principal France",
    "description": "Main product catalog for the French market — Spring/Summer 2024",
    "status": "ACTIVE",
    "createdAt": "2024-02-01T08:00:00.000Z",
    "updatedAt": "2024-03-10T14:00:00.000Z"
  }
}

Related Events

• catalog/created — fired when the catalog is first created

Notes

• The full current state is always included in the payload.
• Status values:
  • DRAFT — catalog is being configured, not yet published
  • ACTIVE — catalog is live and accessible
  • DISABLED — catalog is temporarily hidden/suspended
  • ARCHIVED — catalog is permanently decommissioned
• Monitoring status transitions is particularly important for storefronts that display products based on catalog membership.