vendor/created

Overview

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

Description

Fired when a new vendor is created. A vendor represents a brand or supplier identity that can be associated with products in the catalog. Vendors are used for filtering, reporting, and multi-brand catalog management.

Trigger Conditions

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

Body — Property Table

Vendor Object

Field	Type	Nullable	Description
id	string (uuid)	No	Unique vendor identifier
organizationId	string (uuid)	No	Organization that owns this vendor
name	string	No	Vendor name (unique per organization)
createdAt	string (ISO 8601)	No	Timestamp when the vendor was created
updatedAt	string (ISO 8601)	No	Timestamp of the last update

Full JSON Payload Sample

{
  "header": {
    "organizationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "messageId": "c0d1e2f3-a4b5-6789-cdef-012345678901",
    "webhookId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "type": "vendor/created",
    "date": "2024-01-15T10:00:00.000Z"
  },
  "body": {
    "id": "d1e2f3a4-b5c6-7890-defa-123456789012",
    "organizationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Nike",
    "createdAt": "2024-01-15T10:00:00.000Z",
    "updatedAt": "2024-01-15T10:00:00.000Z"
  }
}

Related Events

• vendor/updated — fired when the vendor name is updated

Notes

• name must be unique within an organization.
• Vendors are referenced by products via the vendorId field on the product entity.
• Deleting a vendor is not supported; vendors associated with products remain active indefinitely.