Product Events

Documentation for product-related webhook events

This section covers all webhook events related to products, including product creation, updates, and deletions.

Event Types

The following product-related events are available:

product.created - Triggered when a new product is created
product.updated - Triggered when an existing product is modified
product.deleted - Triggered when a product is deleted
product_status.changed - Triggered when a product’s status changes

Product Created/Updated Event

The product.created and product.updated events share the same payload structure.

Event Structure

{
  "event_type": "product.created", // product.updated
  "payload": {
    "product_id": "123e4567-e89b-12d3-a456-426614174000",
    "product_name": "Premium Coffee Maker",
    "product_number": "PCM-2024",
    "translations": {
      "name": [
        {
          "country_code": "us",
          "value": "Premium Coffee Maker"
        },
        {
          "country_code": "es",
          "value": "Cafetera Premium"
        }
      ],
      "description": [
        {
          "country_code": "us",
          "value": "High-end coffee maker with temperature control"
        },
        {
          "country_code": "es",
          "value": "Cafetera de alta gama con control de temperatura"
        }
      ],
      "html_description": [
        {
          "country_code": "us",
          "value": "<p>High-end coffee maker with temperature control</p>"
        },
        {
          "country_code": "es",
          "value": "<p>Cafetera de alta gama con control de temperatura</p>"
        }
      ],
      "slug": [
        {
          "country_code": "us",
          "value": "premium-coffee-maker"
        },
        {
          "country_code": "es",
          "value": "cafetera-premium"
        }
      ]
    },
    "files": [],
    "images": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174001",
        "url": "https://example.com/images/coffee-maker.jpg",
        "alt": "Premium Coffee Maker",
        "status": "active",
        "title": "Premium Coffee Maker - Main Image",
        "copyright": "© 2024 Your Brand",
        "sort": 1
      }
    ],
    "slug": "premium-coffee-maker",
    "status": "active",
    "seo": {
      "meta_title": "Premium Coffee Maker | Your Brand",
      "meta_title_translations": [
        {
          "country_code": "us",
          "value": "Premium Coffee Maker | Your Brand"
        }
      ],
      "meta_description": "Discover our high-end coffee maker with precise temperature control.",
      "meta_description_translations": [
        {
          "country_code": "us",
          "value": "Discover our high-end coffee maker with precise temperature control."
        }
      ]
    },
    "description": "High-end coffee maker with temperature control",
    "html_description": "<p>High-end coffee maker with temperature control</p>",
    "markets": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174002",
        "name": "United States",
        "slug": "us",
        "country_code": "US",
        "locale": "en-US",
        "currency_code": "USD",
        "active": true
      }
    ],
    "is_active": true,
    "brand": {
      "id": "123e4567-e89b-12d3-a456-426614174003",
      "name": "Your Brand",
      "series": {
        "id": "123e4567-e89b-12d3-a456-426614174004",
        "name": "Premium Series"
      }
    },
    "custom": {
      "warranty_years": "2",
      "energy_rating": "A+"
    },
    "third_party_links": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174005",
        "type": "manual",
        "title": "User Manual",
        "url": "https://example.com/manuals/coffee-maker.pdf",
        "created_at": "2024-02-12T10:00:00Z",
        "updated_at": "2024-02-12T10:00:00Z"
      }
    ],
    "variant_groups": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174006",
        "product_id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Blue",
        "slug": "blue",
        "created_at": "2024-02-12T10:00:00Z",
        "updated_at": "2024-02-15T14:30:00Z"
      }
    ]
  }
}

variant_groups is omitted (or empty) when the product has no variant groups.

Field Descriptions

Field	Type	Description
`product_id`	string	Unique identifier for the product
`product_name`	string	The name of the product
`product_number`	string	SKU or product number
`translations`	object	Localized content for the product
`files`	array	Associated files (manuals, specs, etc.)
`images`	array	Product images
`slug`	string	URL-friendly identifier
`status`	string	Product status (active, inactive, draft, archived)
`seo`	object	SEO-related information
`description`	string	Product description
`html_description`	string	HTML-formatted product description
`is_active`	boolean	Whether the product is active
`brand`	object	Brand information
`custom`	object	Custom attributes
`third_party_links`	array	External resource links
`variant_groups`	array	Variant groups on the product. Each object: `id`, `product_id`, `name`, `slug`, `created_at`, `updated_at`. Omitted or empty when there are no groups.

Product Deleted Event

The product.deleted event is triggered when a product is removed from the system.

Event Structure

{
  "event_type": "product.deleted",
  "payload": {
    "product_id": "123e4567-e89b-12d3-a456-426614174000",
    "product_number": "PCM-2024"
  }
}

Field Descriptions

Field	Type	Description
`product_id`	string	Unique identifier of the deleted product
`product_number`	string	SKU or product number of the deleted product

Product Status Changed Event

The product_status.changed event is triggered when a product’s status is modified.

Event Structure

{
  "event_type": "product_status.changed",
  "payload": {
    "product_id": "123e4567-e89b-12d3-a456-426614174000",
    "product_number": "PCM-2024",
    "timestamp": "2024-02-12T10:00:00Z",
    "old_status": "draft",
    "new_status": "active"
  }
}

Field Descriptions

Field	Type	Description
`product_id`	string	Unique identifier of the product
`product_number`	string	SKU or product number of the product
`timestamp`	string	ISO 8601 timestamp when the status change occurred
`old_status`	string	The previous status of the product
`new_status`	string	The new status of the product