collection/created

Overview

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

Description

Fired when a new product collection is created. Collections are named groupings of products used to organize catalog content for storefronts, campaigns, or navigation menus.

Trigger Conditions

• A user or integration creates a new collection 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": "collection/created",
    "date": "2024-03-01T09:00:00.000Z"
  },
  "body": { ... }
}

Body — Property Table

Collection Object

Field	Type	Nullable	Description
id	string (uuid)	No	Unique collection identifier
organizationId	string (uuid)	No	Organization that owns this collection
name	string	No	Internal unique name (slug-like)
title	string	No	Human-readable display name
description	string	Yes	Optional description of the collection
createdAt	string (ISO 8601)	No	Timestamp when the collection was created
updatedAt	string (ISO 8601)	No	Timestamp of the last update

Full JSON Payload Sample

{
  "header": {
    "organizationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "messageId": "w4x5y6z7-a8b9-0123-cdef-456789012345",
    "webhookId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "type": "collection/created",
    "date": "2024-03-01T09:00:00.000Z"
  },
  "body": {
    "id": "x5y6z7a8-b9c0-1234-defa-567890123456",
    "organizationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "summer-collection-2024",
    "title": "Summer Collection 2024",
    "description": "Our seasonal summer clothing and accessories range for 2024",
    "createdAt": "2024-03-01T09:00:00.000Z",
    "updatedAt": "2024-03-01T09:00:00.000Z"
  }
}

Related Events

• collection/updated — fired when collection fields change

Notes

• name is a unique slug within an organization and typically cannot be changed after creation.
• Collections are logical groupings only — they do not affect stock levels or fulfillment.
• Product assignment to collections is managed separately via the catalog API.