Webhooks
Product shown webhook event
Webhook data sent when a product is added back to a store
Webhook data
type ProductShownData {
id: string;
title: string;
slug: string;
model: string | null;
brand: string | null;
description: string;
isInStock: boolean;
isDiscontinued: boolean;
priceRange: { minVariantPrice: number; maxVariantPrice: number };
retailPriceRange?: { minVariantPrice: number; maxVariantPrice: number };
options: {
name: 'size' | 'color';
values: { title: string; colorCode?: string; colorCode2?: string }[];
}[];
variants: {
id: string;
images: { url: string; lowResUrl: string; width: number; height: number }[];
isAvailableForSale: boolean;
options: {
name: 'size' | 'color';
value: { title: string; colorCode?: string; colorCode2?: string };
}[];
price: number;
retailPrice?: number;
title: string;
}[];
featuredImage: {
url: string;
lowResUrl: string;
width: number;
height: number;
};
};
Example Webhook data
{
"id": "68a44ab2-6e2f-4474-9dc8-b0033638c7dc",
"title": "Men's Champion Sweatshirt",
"slug": "mens-champion-sweatshirt",
"model": "Sweatshirt",
"brand": "Champion",
"description": "A cool sweatshirt",
"isInStock": true,
"isDiscontinued": false,
"priceRange": {
"minVariantPrice": 10,
"maxVariantPrice": 11
},
"priceMarkup": {
"type": "FlatPercent",
"value": 5
},
"options": [
{
"name": "size",
"values": [
{
"title": "L"
},
{
"title": "M"
}
]
},
{
"name": "color",
"values": [
{
"title": "White",
"colorCode": "#FFFFFF"
},
{
"title": "Black",
"colorCode": "#000000"
}
]
}
],
"variants": [
{
"id": "002196d0-fecd-4633-94d6-abd3675bdb2d",
images: [
{
"width": 1000,
"height": 1000,
"url": "https://media.covver.io/mockups/eabce69f-daa7-45b3-a7bf-f374fac95efd.jpeg",
"lowResUrl": "https://media.covver.io/mockups/eabce69f-daa7-45b3-a7bf-f374fac95efd.jpeg"
}
],
"isAvailableForSale": true,
"options": [
{
"name": "size",
"value": {
"title": "L"
}
},
{
"name": "color",
"value": {
"title": "Black",
"colorCode": "#000000"
}
}
],
"price": 10,
"title": "Black"
}
],
"featuredImage": {
"width": 1000,
"height": 1000,
"url": "https://media.covver.io/mockups/eabce69f-daa7-45b3-a7bf-f374fac95efd.jpeg",
"lowResUrl": "https://media.covver.io/mockups/eabce69f-daa7-45b3-a7bf-f374fac95efd.jpeg"
}
}