collection/updated

Overview

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

Description

Fired when any field on an existing collection is updated, such as the title or description.

Trigger Conditions

• A user or integration updates collection fields 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/updated",
    "date": "2024-04-15T11:30: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 (immutable)
title	string	No	Human-readable display name
description	string	Yes	Optional description
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": "y6z7a8b9-c0d1-2345-efab-678901234567",
    "webhookId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "type": "collection/updated",
    "date": "2024-04-15T11:30:00.000Z"
  },
  "body": {
    "id": "x5y6z7a8-b9c0-1234-defa-567890123456",
    "organizationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "summer-collection-2024",
    "title": "Summer Collection 2024 — Extended",
    "description": "Our seasonal summer clothing, accessories, and new swimwear range for 2024",
    "createdAt": "2024-03-01T09:00:00.000Z",
    "updatedAt": "2024-04-15T11:30:00.000Z"
  }
}

Related Events

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

Notes

• The full current state of the collection is always included in the payload.
• name is immutable and will never change after creation.
• Product membership changes within a collection do not trigger this event — only collection metadata changes do.