{
"id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
"webhookId": "00aa4abd-5778-4199-8161-0b49b2f212e5",
"shopId": "sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb",
"type": "PROMOTION_STATUS_CHANGED",
"apiVersion": "V1",
"createdAt": "2020-08-13T09:05:36.939+00:00",
"testMode": false,
"data": {
"id": "<string>",
"code": "<string>",
"discount": {
"percentage": 123,
"type": "FLAT_RATE",
"money": {
"value": 10,
"currency": "USD"
},
"freeShipping": true
},
"requirements": {},
"usageCount": 123,
"limits": {
"maximumUsesNumber": 123,
"oneUsePerCustomer": true
},
"appliesTo": {
"type": "ENTIRE_ORDER"
},
"type": "SHOP_SINGLE"
}
}Webhook Events
Promotion status changed
Fired when a promotion’s status changes (e.g., activated, expired).
WEBHOOK
PROMOTION_STATUS_CHANGED
{
"id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
"webhookId": "00aa4abd-5778-4199-8161-0b49b2f212e5",
"shopId": "sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb",
"type": "PROMOTION_STATUS_CHANGED",
"apiVersion": "V1",
"createdAt": "2020-08-13T09:05:36.939+00:00",
"testMode": false,
"data": {
"id": "<string>",
"code": "<string>",
"discount": {
"percentage": 123,
"type": "FLAT_RATE",
"money": {
"value": 10,
"currency": "USD"
},
"freeShipping": true
},
"requirements": {},
"usageCount": 123,
"limits": {
"maximumUsesNumber": 123,
"oneUsePerCustomer": true
},
"appliesTo": {
"type": "ENTIRE_ORDER"
},
"type": "SHOP_SINGLE"
}
}Body
application/json
Unique identifier for this webhook event
Example:
"00aa4abd-5778-4199-8161-0b49b2f212e5"
ID of the webhook configuration that triggered this event
Example:
"00aa4abd-5778-4199-8161-0b49b2f212e5"
ID of the shop that generated this event
Example:
"sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb"
The event type
Example:
"PROMOTION_STATUS_CHANGED"
API version of the webhook payload
Example:
"V1"
When this event was created
Example:
"2020-08-13T09:05:36.939+00:00"
Whether this event was sent in test mode
Example:
false
- Single Shop Promotion
- Multi Shop Promotion
- Auto Applying Shop Promotion
- Single Memberships Promotion
- Multi Memberships Promotion
Show child attributes
Show child attributes
Response
200
Event received successfully