vendor/updated

Overview

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

Description

Fired when a vendor's details are updated. Currently the only mutable field on a vendor is name.

Trigger Conditions

• A user or integration updates the vendor name 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/updated",
    "date": "2024-06-20T16: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	Updated vendor name
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": "e2f3a4b5-c6d7-8901-efab-234567890123",
    "webhookId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "type": "vendor/updated",
    "date": "2024-06-20T16:00:00.000Z"
  },
  "body": {
    "id": "d1e2f3a4-b5c6-7890-defa-123456789012",
    "organizationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Nike — Official",
    "createdAt": "2024-01-15T10:00:00.000Z",
    "updatedAt": "2024-06-20T16:00:00.000Z"
  }
}

Related Events

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

Notes

• A vendor name change propagates the new name to all products associated with this vendor in your integration.
• id and organizationId never change — use id as the stable reference, not name.