Series Events
Documentation for series-related webhook events
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 updatedseries.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
| Field | Type | Description |
|---|---|---|
id |
string | Unique identifier for the series |
name |
string | Display name of the series |
slug |
string | URL-friendly identifier |
description |
string | Optional description of the series |
logo_url |
string | Optional URL to the series logo |
cover_url |
string | Optional URL to the series cover image |
created_at |
string | Creation timestamp |
updated_at |
string | Last 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
| Field | Type | Description |
|---|---|---|
id |
string | Unique identifier of the deleted series |