Skip to main content
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": "<string>",
      "money": {
        "value": 10,
        "currency": "USD"
      },
      "freeShipping": true,
      "shippingOption": "Included"
    },
    "status": "Live",
    "requirements": {
      "minimumOrderValue": {
        "value": 10,
        "currency": "USD"
      }
    },
    "usageCount": 123,
    "limits": {
      "maximumUsesNumber": 123,
      "oneUsePerCustomer": true
    },
    "appliesTo": {
      "type": "<string>"
    },
    "type": "<string>"
  }
}

Body

application/json
​
id
string
required

Unique identifier for this webhook event

Example:

"00aa4abd-5778-4199-8161-0b49b2f212e5"

​
webhookId
string
required

ID of the webhook configuration that triggered this event

Example:

"00aa4abd-5778-4199-8161-0b49b2f212e5"

​
shopId
string
required

ID of the shop that generated this event

Example:

"sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb"

​
type
string
required

The event type

Example:

"PROMOTION_STATUS_CHANGED"

​
apiVersion
string
required

API version of the webhook payload

Example:

"V1"

​
createdAt
string<date-time>
required

When this event was created

Example:

"2020-08-13T09:05:36.939+00:00"

​
testMode
any
required

Whether this event was sent in test mode

Example:

false

​
data
Single Shop Promotion · object
required

Response

200

Event received successfully