/
Coupon applied

Coupon applied
Webhook

Request

Security
SecretApiKey or JWT
Bodyapplication/json

Payload of coupon redemption-related webhook event.

couponIdstring

ID of the coupon.

redemptionIdstring

ID of the redemption.

customerIdstring

ID of the customer.

eventTypestring

Type of event that triggered the webhook.

Enum:"coupon-application-removed""coupon-applied""coupon-redeemed""coupon-redemption-canceled"
_embeddedobject

Embedded objects related to the coupon redemption event.

Payload
{
  "couponId": "string",
  "redemptionId": "string",
  "customerId": "string",
  "eventType": "coupon-application-removed",
  "_embedded": {
    "coupon": { … },
    "redemption": { … },
    "customer": { … }
  },
  "_links": [
    { … }
  ]
}

Responses

Returns any 2xx status to indicate that data is received.