Skip to main content
This section covers all webhook events related to product series, including series creation, updates, and deletions.

Event Types

The following series-related events are available:
  • series.upsert - Triggered when a product series is created or updated
  • series.delete - Triggered when a product series is deleted

Series Upsert Event

The series.upsert event is triggered when a product series is created or updated.

Event Structure

{
  "event_type": "series.upsert",
  "payload": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Summer Collection",
    "slug": "summer-collection",
    "description": "Light and breezy summer styles",
    "logo_url": "https://example.com/series/summer.png",
    "cover_url": "https://example.com/series/summer-cover.jpg",
    "created_at": "2024-02-12T12:00:00Z",
    "updated_at": "2024-02-12T12:00:00Z"
  }
}

Field Descriptions

FieldTypeDescription
idstringUnique identifier for the series
namestringDisplay name of the series
slugstringURL-friendly identifier
descriptionstringOptional description of the series
logo_urlstringOptional URL to the series logo
cover_urlstringOptional URL to the series cover image
created_atstringCreation timestamp
updated_atstringLast update timestamp

Series Delete Event

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

Event Structure

{
  "event_type": "series.delete",
  "payload": {
    "id": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Field Descriptions

FieldTypeDescription
idstringUnique identifier of the deleted series