catalog/created

Overview

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

Description

Fired when a new catalog is created. A catalog is a structured product hierarchy for an organization. Multiple catalogs can co-exist (e.g., one per sales channel or market), each with its own status and set of entries.

Trigger Conditions

• A user or integration creates a new catalog via the HappyColis API

Message Envelope

{
  "header": {
    "organizationId": "org_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "messageId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "webhookId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "type": "catalog/created",
    "date": "2024-02-01T08: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 (slug-like)
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	Timestamp when the catalog was created
updatedAt	string (ISO 8601)	No	Timestamp of the last update

Full JSON Payload Sample

{
  "header": {
    "organizationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "messageId": "z7a8b9c0-d1e2-3456-fabc-789012345678",
    "webhookId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "type": "catalog/created",
    "date": "2024-02-01T08: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",
    "status": "DRAFT",
    "createdAt": "2024-02-01T08:00:00.000Z",
    "updatedAt": "2024-02-01T08:00:00.000Z"
  }
}

Related Events

• catalog/updated — fired when catalog fields change (including status transitions)

Notes

• A catalog starts in DRAFT status by default and must be explicitly activated.
• Status lifecycle: DRAFT → ACTIVE → DISABLED → ARCHIVED
• Catalog entries (categories/subcategories) are managed separately and do not trigger this event.
• name is a unique identifier within an organization.