Notification schemas (1.0.0)

Download OpenAPI specification:Download

Use Application notifications and loyalty notifications to notify the system of your choice of certain changes that happened in Talon.One.

Campaign notifications

Represents the notifications about campaign-related changes.

Note: The value of the NotificationType property indicates the campaign change:

CampaignNotification signifies one of the following events:
CampaignEvaluationTreeChanged signifies Campaign evaluation tree changed.

Campaign created Webhook

Request Body schema: application/json

The notification indicating a campaign was created.

TotalResultSize required	integer The number of campaign notifications inside the `Data` array.
NotificationType required	string Value: "CampaignNotification" The type of notification.
required	Array of objects A notification regarding a campaign that was created.

Request samples

Payload

Content type

application/json

{"TotalResultSize": 322,
"NotificationType": "CampaignNotification",
"Data": [{"campaign": {"id": 0,
"created": "2019-08-24T14:15:22Z",
"applicationId": 322,
"userId": 0,
"name": "Summer promotions",
"description": "Campaign for all summer 2021 promotions",
"startTime": "2021-07-20T22:00:00Z",
"endTime": "2021-09-22T22:00:00Z",
"attributes": { },
"state": "enabled",
"activeRulesetId": 0,
"tags": ["summer"
],
"features": ["coupons",
"referrals"
],
"couponSettings": {"validCharacters": ["A",
"B",
"C",
"D",
"E",
"2",
"0"
],
"couponPattern": "SUMMER-####-####"
},
"referralSettings": {"validCharacters": ["A",
"B",
"C",
"D",
"E",
"2",
"0"
],
"couponPattern": "SUMMER-####-####"
},
"limits": [{"action": "createCoupon",
"limit": 1000,
"period": "yearly",
"entities": ["Coupon"
]
}
],
"campaignGroups": [1,
3
],
"couponRedemptionCount": 163,
"referralRedemptionCount": 3,
"discountCount": 288,
"discountEffectCount": 343,
"couponCreationCount": 16,
"customEffectCount": 0,
"referralCreationCount": 8,
"addFreeItemEffectCount": 0,
"awardedGiveawaysCount": 9,
"createdLoyaltyPointsCount": 9,
"createdLoyaltyPointsEffectCount": 2,
"redeemedLoyaltyPointsCount": 8,
"redeemedLoyaltyPointsEffectCount": 9,
"callApiEffectCount": 0,
"lastActivity": "2022-11-10T23:00:00Z",
"updated": "2022-10-97T35:00:00Z",
"createdBy": "John Doe",
"updatedBy": "Jane Doe",
"frontendState": "running",
"templateId": 3,
"linkedStoreIds": [1,
2,
3
]
},
"ruleset": {"id": 6,
"created": "2020-06-10T09:05:27.993483Z",
"userId": 0,
"rules": [{"title": "Give discount via coupon",
"description": "Creates a discount when a coupon is valid",
"bindings": [{"name": "my property",
"type": "templateParameter",
"expression": [ ],
"valueType": "string"
}
],
"condition": ["and",
["couponValid"
]
],
"effects": ["catch",
["noop"
],
["setDiscount",
"10% off",
["*",
[".",
"Session",
"Total"
],
["/",
10,
100
]
]
]
]
}
],
"bindings": [ ],
"rbVersion": "v2",
"activate": true,
"campaignId": 320,
"templateId": 3,
"activatedAt": "2019-08-24T14:15:22Z"
},
"evaluationPosition": {"groupId": 2,
"groupName": "Summer campaigns",
"position": 2
},
"Event": "campaign_created"
}
]
}

Campaign state changed Webhook

Request Body schema: application/json

The notification indicating the state of a campaign changed.

TotalResultSize required	integer The number of campaign notifications inside the `Data` array.
NotificationType required	string Value: "CampaignNotification" The type of notification.
required	Array of objects A notification regarding a campaign whose state changed.

Request samples

Payload

Content type

application/json

{"TotalResultSize": 322,
"NotificationType": "CampaignNotification",
"Data": [{"campaign": {"id": 0,
"created": "2019-08-24T14:15:22Z",
"applicationId": 322,
"userId": 0,
"name": "Summer promotions",
"description": "Campaign for all summer 2021 promotions",
"startTime": "2021-07-20T22:00:00Z",
"endTime": "2021-09-22T22:00:00Z",
"attributes": { },
"state": "enabled",
"activeRulesetId": 0,
"tags": ["summer"
],
"features": ["coupons",
"referrals"
],
"couponSettings": {"validCharacters": ["A",
"B",
"C",
"D",
"E",
"2",
"0"
],
"couponPattern": "SUMMER-####-####"
},
"referralSettings": {"validCharacters": ["A",
"B",
"C",
"D",
"E",
"2",
"0"
],
"couponPattern": "SUMMER-####-####"
},
"limits": [{"action": "createCoupon",
"limit": 1000,
"period": "yearly",
"entities": ["Coupon"
]
}
],
"campaignGroups": [1,
3
],
"couponRedemptionCount": 163,
"referralRedemptionCount": 3,
"discountCount": 288,
"discountEffectCount": 343,
"couponCreationCount": 16,
"customEffectCount": 0,
"referralCreationCount": 8,
"addFreeItemEffectCount": 0,
"awardedGiveawaysCount": 9,
"createdLoyaltyPointsCount": 9,
"createdLoyaltyPointsEffectCount": 2,
"redeemedLoyaltyPointsCount": 8,
"redeemedLoyaltyPointsEffectCount": 9,
"callApiEffectCount": 0,
"lastActivity": "2022-11-10T23:00:00Z",
"updated": "2022-10-97T35:00:00Z",
"createdBy": "John Doe",
"updatedBy": "Jane Doe",
"frontendState": "running",
"templateId": 3,
"linkedStoreIds": [1,
2,
3
]
},
"ruleset": {"id": 6,
"created": "2020-06-10T09:05:27.993483Z",
"userId": 0,
"rules": [{"title": "Give discount via coupon",
"description": "Creates a discount when a coupon is valid",
"bindings": [{"name": "my property",
"type": "templateParameter",
"expression": [ ],
"valueType": "string"
}
],
"condition": ["and",
["couponValid"
]
],
"effects": ["catch",
["noop"
],
["setDiscount",
"10% off",
["*",
[".",
"Session",
"Total"
],
["/",
10,
100
]
]
]
]
}
],
"bindings": [ ],
"rbVersion": "v2",
"activate": true,
"campaignId": 320,
"templateId": 3,
"activatedAt": "2019-08-24T14:15:22Z"
},
"oldState": "string",
"newState": "string",
"Event": "campaign_state_changed"
}
]
}

Campaign rules changed Webhook

Request Body schema: application/json

The notification indicating the rules of a campaign changed.

TotalResultSize required	integer The number of campaign notifications inside the `Data` array.
NotificationType required	string Value: "CampaignNotification" The type of notification.
required	Array of objects A notification regarding a campaign whose ruleset was changed.

Request samples

Payload

Content type

application/json

{"TotalResultSize": 322,
"NotificationType": "CampaignNotification",
"Data": [{"campaign": {"id": 0,
"created": "2019-08-24T14:15:22Z",
"applicationId": 322,
"userId": 0,
"name": "Summer promotions",
"description": "Campaign for all summer 2021 promotions",
"startTime": "2021-07-20T22:00:00Z",
"endTime": "2021-09-22T22:00:00Z",
"attributes": { },
"state": "enabled",
"activeRulesetId": 0,
"tags": ["summer"
],
"features": ["coupons",
"referrals"
],
"couponSettings": {"validCharacters": ["A",
"B",
"C",
"D",
"E",
"2",
"0"
],
"couponPattern": "SUMMER-####-####"
},
"referralSettings": {"validCharacters": ["A",
"B",
"C",
"D",
"E",
"2",
"0"
],
"couponPattern": "SUMMER-####-####"
},
"limits": [{"action": "createCoupon",
"limit": 1000,
"period": "yearly",
"entities": ["Coupon"
]
}
],
"campaignGroups": [1,
3
],
"couponRedemptionCount": 163,
"referralRedemptionCount": 3,
"discountCount": 288,
"discountEffectCount": 343,
"couponCreationCount": 16,
"customEffectCount": 0,
"referralCreationCount": 8,
"addFreeItemEffectCount": 0,
"awardedGiveawaysCount": 9,
"createdLoyaltyPointsCount": 9,
"createdLoyaltyPointsEffectCount": 2,
"redeemedLoyaltyPointsCount": 8,
"redeemedLoyaltyPointsEffectCount": 9,
"callApiEffectCount": 0,
"lastActivity": "2022-11-10T23:00:00Z",
"updated": "2022-10-97T35:00:00Z",
"createdBy": "John Doe",
"updatedBy": "Jane Doe",
"frontendState": "running",
"templateId": 3,
"linkedStoreIds": [1,
2,
3
]
},
"oldRuleset": {"id": 6,
"created": "2020-06-10T09:05:27.993483Z",
"userId": 0,
"rules": [{"title": "Give discount via coupon",
"description": "Creates a discount when a coupon is valid",
"bindings": [{"name": "my property",
"type": "templateParameter",
"expression": [ ],
"valueType": "string"
}
],
"condition": ["and",
["couponValid"
]
],
"effects": ["catch",
["noop"
],
["setDiscount",
"10% off",
["*",
[".",
"Session",
"Total"
],
["/",
10,
100
]
]
]
]
}
],
"bindings": [ ],
"rbVersion": "v2",
"activate": true,
"campaignId": 320,
"templateId": 3,
"activatedAt": "2019-08-24T14:15:22Z"
},
"ruleset": {"id": 6,
"created": "2020-06-10T09:05:27.993483Z",
"userId": 0,
"rules": [{"title": "Give discount via coupon",
"description": "Creates a discount when a coupon is valid",
"bindings": [{"name": "my property",
"type": "templateParameter",
"expression": [ ],
"valueType": "string"
}
],
"condition": ["and",
["couponValid"
]
],
"effects": ["catch",
["noop"
],
["setDiscount",
"10% off",
["*",
[".",
"Session",
"Total"
],
["/",
10,
100
]
]
]
]
}
],
"bindings": [ ],
"rbVersion": "v2",
"activate": true,
"campaignId": 320,
"templateId": 3,
"activatedAt": "2019-08-24T14:15:22Z"
},
"Event": "campaign_ruleset_changed"
}
]
}

Campaign edited Webhook

Request Body schema: application/json

The notification indicating a campaign was edited.

TotalResultSize required	integer The number of campaign notifications inside the `Data` array.
NotificationType required	string Value: "CampaignNotification" The type of notification.
required	Array of objects A notification regarding a campaign that was edited.

Request samples

Payload

Content type

application/json

{"TotalResultSize": 322,
"NotificationType": "CampaignNotification",
"Data": [{"campaign": {"id": 0,
"created": "2019-08-24T14:15:22Z",
"applicationId": 322,
"userId": 0,
"name": "Summer promotions",
"description": "Campaign for all summer 2021 promotions",
"startTime": "2021-07-20T22:00:00Z",
"endTime": "2021-09-22T22:00:00Z",
"attributes": { },
"state": "enabled",
"activeRulesetId": 0,
"tags": ["summer"
],
"features": ["coupons",
"referrals"
],
"couponSettings": {"validCharacters": ["A",
"B",
"C",
"D",
"E",
"2",
"0"
],
"couponPattern": "SUMMER-####-####"
},
"referralSettings": {"validCharacters": ["A",
"B",
"C",
"D",
"E",
"2",
"0"
],
"couponPattern": "SUMMER-####-####"
},
"limits": [{"action": "createCoupon",
"limit": 1000,
"period": "yearly",
"entities": ["Coupon"
]
}
],
"campaignGroups": [1,
3
],
"couponRedemptionCount": 163,
"referralRedemptionCount": 3,
"discountCount": 288,
"discountEffectCount": 343,
"couponCreationCount": 16,
"customEffectCount": 0,
"referralCreationCount": 8,
"addFreeItemEffectCount": 0,
"awardedGiveawaysCount": 9,
"createdLoyaltyPointsCount": 9,
"createdLoyaltyPointsEffectCount": 2,
"redeemedLoyaltyPointsCount": 8,
"redeemedLoyaltyPointsEffectCount": 9,
"callApiEffectCount": 0,
"lastActivity": "2022-11-10T23:00:00Z",
"updated": "2022-10-97T35:00:00Z",
"createdBy": "John Doe",
"updatedBy": "Jane Doe",
"frontendState": "running",
"templateId": 3,
"linkedStoreIds": [1,
2,
3
]
},
"oldCampaign": {"id": 0,
"created": "2019-08-24T14:15:22Z",
"applicationId": 322,
"userId": 0,
"name": "Summer promotions",
"description": "Campaign for all summer 2021 promotions",
"startTime": "2021-07-20T22:00:00Z",
"endTime": "2021-09-22T22:00:00Z",
"attributes": { },
"state": "enabled",
"activeRulesetId": 0,
"tags": ["summer"
],
"features": ["coupons",
"referrals"
],
"couponSettings": {"validCharacters": ["A",
"B",
"C",
"D",
"E",
"2",
"0"
],
"couponPattern": "SUMMER-####-####"
},
"referralSettings": {"validCharacters": ["A",
"B",
"C",
"D",
"E",
"2",
"0"
],
"couponPattern": "SUMMER-####-####"
},
"limits": [{"action": "createCoupon",
"limit": 1000,
"period": "yearly",
"entities": ["Coupon"
]
}
],
"campaignGroups": [1,
3
],
"couponRedemptionCount": 163,
"referralRedemptionCount": 3,
"discountCount": 288,
"discountEffectCount": 343,
"couponCreationCount": 16,
"customEffectCount": 0,
"referralCreationCount": 8,
"addFreeItemEffectCount": 0,
"awardedGiveawaysCount": 9,
"createdLoyaltyPointsCount": 9,
"createdLoyaltyPointsEffectCount": 2,
"redeemedLoyaltyPointsCount": 8,
"redeemedLoyaltyPointsEffectCount": 9,
"callApiEffectCount": 0,
"lastActivity": "2022-11-10T23:00:00Z",
"updated": "2022-10-97T35:00:00Z",
"createdBy": "John Doe",
"updatedBy": "Jane Doe",
"frontendState": "running",
"templateId": 3,
"linkedStoreIds": [1,
2,
3
]
},
"ruleset": {"id": 6,
"created": "2020-06-10T09:05:27.993483Z",
"userId": 0,
"rules": [{"title": "Give discount via coupon",
"description": "Creates a discount when a coupon is valid",
"bindings": [{"name": "my property",
"type": "templateParameter",
"expression": [ ],
"valueType": "string"
}
],
"condition": ["and",
["couponValid"
]
],
"effects": ["catch",
["noop"
],
["setDiscount",
"10% off",
["*",
[".",
"Session",
"Total"
],
["/",
10,
100
]
]
]
]
}
],
"bindings": [ ],
"rbVersion": "v2",
"activate": true,
"campaignId": 320,
"templateId": 3,
"activatedAt": "2019-08-24T14:15:22Z"
},
"Event": "campaign_edited"
}
]
}

Campaign deleted Webhook

Request Body schema: application/json

The notification indicating a campaign was deleted.

TotalResultSize required	integer The number of campaign notifications inside the `Data` array.
NotificationType required	string Value: "CampaignNotification" The type of notification.
required	Array of objects A notification regarding a campaign that was deleted.

Request samples

Payload

Content type

application/json

{"TotalResultSize": 322,
"NotificationType": "CampaignNotification",
"Data": [{"campaign": {"id": 0,
"created": "2019-08-24T14:15:22Z",
"applicationId": 322,
"userId": 0,
"name": "Summer promotions",
"description": "Campaign for all summer 2021 promotions",
"startTime": "2021-07-20T22:00:00Z",
"endTime": "2021-09-22T22:00:00Z",
"attributes": { },
"state": "enabled",
"activeRulesetId": 0,
"tags": ["summer"
],
"features": ["coupons",
"referrals"
],
"couponSettings": {"validCharacters": ["A",
"B",
"C",
"D",
"E",
"2",
"0"
],
"couponPattern": "SUMMER-####-####"
},
"referralSettings": {"validCharacters": ["A",
"B",
"C",
"D",
"E",
"2",
"0"
],
"couponPattern": "SUMMER-####-####"
},
"limits": [{"action": "createCoupon",
"limit": 1000,
"period": "yearly",
"entities": ["Coupon"
]
}
],
"campaignGroups": [1,
3
],
"couponRedemptionCount": 163,
"referralRedemptionCount": 3,
"discountCount": 288,
"discountEffectCount": 343,
"couponCreationCount": 16,
"customEffectCount": 0,
"referralCreationCount": 8,
"addFreeItemEffectCount": 0,
"awardedGiveawaysCount": 9,
"createdLoyaltyPointsCount": 9,
"createdLoyaltyPointsEffectCount": 2,
"redeemedLoyaltyPointsCount": 8,
"redeemedLoyaltyPointsEffectCount": 9,
"callApiEffectCount": 0,
"lastActivity": "2022-11-10T23:00:00Z",
"updated": "2022-10-97T35:00:00Z",
"createdBy": "John Doe",
"updatedBy": "Jane Doe",
"frontendState": "running",
"templateId": 3,
"linkedStoreIds": [1,
2,
3
]
},
"deletedAt": "2022-11-10T23:00:00Z",
"Event": "campaign_deleted"
}
]
}

Campaign evaluation tree changed Webhook

Request Body schema: application/json

The notification indicating the campaign evaluation tree of an Application changed.

The campaign evaluation tree changes, for example, when a campaign is created (including copying other campaigns) or deleted, or when a campaign evaluation group is modified. To learn more, see Managing campaign evaluation.

TotalResultSize required	integer The number of campaign notifications inside the `Data` array.
NotificationType required	string Value: "CampaignEvaluationTreeChanged" The type of notification.
required	Array of objects Notification about an Application whose campaigns' evaluation tree changed.

Request samples

Payload

Content type

application/json

{"TotalResultSize": 322,
"NotificationType": "CampaignEvaluationTreeChanged",
"Data": [{"applicationId": 78,
"oldEvaluationTree": {"id": 6,
"created": "2020-06-10T09:05:27.993483Z",
"applicationId": 322,
"version": 3,
"set": {"type": "SET",
"name": "Summer campaigns",
"operator": "ALL",
"elements": [{"type": "SET"
}
],
"groupId": 2,
"description": "This campaign evaluation group contains all campaigns that are running in the summer.",
"evaluationMode": "stackable"
},
"updatedBy": "Jane Doe"
},
"evaluationTree": {"id": 6,
"created": "2020-06-10T09:05:27.993483Z",
"applicationId": 322,
"version": 3,
"set": {"type": "SET",
"name": "Summer campaigns",
"operator": "ALL",
"elements": [{"type": "SET"
}
],
"groupId": 2,
"description": "This campaign evaluation group contains all campaigns that are running in the summer.",
"evaluationMode": "stackable"
},
"updatedBy": "Jane Doe"
},
"event": "campaign_evaluation_tree_changed"
}
]
}

Coupon notifications

Represents the notifications about coupons.

Coupon created Webhook

Request Body schema: application/json

The notification indicating that one of the following coupon-related changes occurred:

Coupon created (via the Campaign Manager or Create coupons endpoint).
Coupon created for multiple recipients (via the Create coupons for multiple recipients endpoint).
Coupon created (as a result of the couponCreated API effect, triggered by the Rule Engine).

TypeOfChange required	string Enum: "campaign_manager" "management_api" "rule_engine" The notification source, that is, it indicates whether the coupons were changed via one of the following routes: The Campaign Manager Management API Rule Engine
Operation required	string Enum: "CouponCreated" "CouponUpdated" "CouponDeleted" "AsyncCouponsCreated" "CouponsDeleted" "CouponsUpdated" The change (creation, update, or deletion) made to the coupons.
EmployeeName required	string The name of the employee who made the coupon-related changes. Note: This can be blank when the notication source is the Rule Engine.
NotificationType required	string Enum: "CouponCreated" "CouponUpdated" "CouponDeleted" "AsyncCouponsCreated" "CouponsDeleted" "CouponsUpdated" The type of notification.
	Array of objects The array of coupons codes. If 1000 or fewer coupons are requested, all coupon data is sent. If 1001 or more coupons are requested, only `BatchID` is sent.
totalResultSize	number The number of changed coupons.
BatchID	string The ID of the batch to which the coupon belongs. Note: The Batch ID is generated when coupons are created.

Request samples

Payload

Content type

application/json

Example

LessThan1000Coupons

{"TypeOfChange": "campaign_manager",
"Operation": "CouponCreated",
"EmployeeName": "Franziska Schneider",
"totalResultSize": 2,
"data": [{"id": 1,
"created": "2023-01-31T15:19:25.18417+01:00",
"campaignId": 1,
"value": "73KXKKFP",
"usageLimit": 1,
"reservationLimit": 0,
"usageCounter": 0,
"attributes": { },
"reservation": true,
"batchId": "nqylhnni"
},
{"id": 2,
"created": "2023-01-31T15:19:25.18417+01:00",
"campaignId": 1,
"value": "BH3CXXLW",
"usageLimit": 1,
"reservationLimit": 0,
"usageCounter": 0,
"attributes": { },
"reservation": true,
"batchId": "nqylhnni"
}
]
}

Coupon updated or deleted Webhook

Request Body schema: application/json

The notification indicating that one of the following coupon-related changes occurred:

Coupon updated (via the Campaign Manager or Update coupon endpoint).
Coupon deleted (via the Campaign Manager or Delete coupon endpoint).
Coupon updated (as a result of the updateAttribute API effect, triggered by the Rule Engine).

TypeOfChange required	string Enum: "campaign_manager" "management_api" "rule_engine" The notification source, that is, it indicates whether the coupons were changed via one of the following routes: The Campaign Manager Management API Rule Engine
Operation required	string Enum: "CouponCreated" "CouponUpdated" "CouponDeleted" "AsyncCouponsCreated" "CouponsDeleted" "CouponsUpdated" The change (creation, update, or deletion) made to the coupons.
EmployeeName required	string The name of the employee who made the coupon-related changes. Note: This can be blank when the notication source is the Rule Engine.
NotificationType required	string Enum: "CouponCreated" "CouponUpdated" "CouponDeleted" "AsyncCouponsCreated" "CouponsDeleted" "CouponsUpdated" The type of notification.
required	Array of objects The array of coupons codes.
totalResultSize required	number The number of changed coupons.

Request samples

Payload

Content type

application/json

{"TypeOfChange": "campaign_manager",
"Operation": "CouponCreated",
"NotificationType": "CouponCreated",
"EmployeeName": "Franziska Schneider",
"data": [{"id": 1,
"created": "2023-01-31T15:19:25.18417+01:00",
"campaignId": 1,
"value": "73KXKKFP",
"usageLimit": 1,
"reservationLimit": 0,
"usageCounter": 0,
"attributes": { },
"reservation": true,
"batchId": "nqylhnni"
},
{"id": 2,
"created": "2023-01-31T15:19:25.18417+01:00",
"campaignId": 1,
"value": "BH3CXXLW",
"usageLimit": 1,
"reservationLimit": 0,
"usageCounter": 0,
"attributes": { },
"reservation": true,
"batchId": "nqylhnni"
}
],
"totalResultSize": 2
}

Coupons created asynchronously Webhook

Request Body schema: application/json

The notification indicating that up to 5 million coupons were created asynchronously via the Create coupons asynchronously endpoint.

In this case, instead of individual notifications for specific coupon changes (such as creation, update, or deletion), a single notification about the completion of the batch processing of coupons with details about the batch is sent.

Tip: To retrieve information about the generated coupons, after receiving the notification, use the Export coupons endpoint along with the batchid, which indicates the batch to which the coupons belong.

TypeOfChange required	string Enum: "campaign_manager" "management_api" "rule_engine" The notification source, that is, it indicates whether the coupons were changed via one of the following routes: The Campaign Manager Management API Rule Engine
Operation required	string Enum: "CouponCreated" "CouponUpdated" "CouponDeleted" "AsyncCouponsCreated" "CouponsDeleted" "CouponsUpdated" The change (creation, update, or deletion) made to the coupons.
EmployeeName required	string The name of the employee who made the coupon-related changes. Note: This can be blank when the notication source is the Rule Engine.
NotificationType required	string Enum: "CouponCreated" "CouponUpdated" "CouponDeleted" "AsyncCouponsCreated" "CouponsDeleted" "CouponsUpdated" The type of notification.
BatchID required	string The ID of the batch to which the coupon belongs. Note: The Batch ID is generated when coupons are created.

Request samples

Payload

Content type

application/json

{"TypeOfChange": "campaign_manager",
"Operation": "AsyncCouponsCreated",
"EmployeeName": "Franziska Schneider",
"BatchID": "nqylhnni"
}

Coupons updated Webhook

Request Body schema: application/json

The notification indicating that coupons were updated via the Update coupons endpoint.

TypeOfChange required	string Enum: "campaign_manager" "management_api" "rule_engine" The notification source, that is, it indicates whether the coupons were changed via one of the following routes: The Campaign Manager Management API Rule Engine
Operation required	string Enum: "CouponCreated" "CouponUpdated" "CouponDeleted" "AsyncCouponsCreated" "CouponsDeleted" "CouponsUpdated" The change (creation, update, or deletion) made to the coupons.
EmployeeName required	string The name of the employee who made the coupon-related changes. Note: This can be blank when the notication source is the Rule Engine.
NotificationType required	string Enum: "CouponCreated" "CouponUpdated" "CouponDeleted" "AsyncCouponsCreated" "CouponsDeleted" "CouponsUpdated" The type of notification.
BatchID required	string The ID of the batch to which the coupon belongs. Note: The Batch ID is generated when coupons are created. The Batch ID may be empty, for example, if all coupons in the campaign were updated.
ApplicationID required	number >= 1 The ID of the Application to which the coupon belongs.
CampaignID required	number >= 1 The ID of the campaign to which the coupon belongs.

Request samples

Payload

Content type

application/json

{"TypeOfChange": "campaign_manager",
"Operation": "CouponsUpdated",
"EmployeeName": "Franziska Schneider",
"BatchID": "nqylhnni",
"ApplicationID": 5,
"CampaignID": 3
}

Coupons deleted Webhook

Request Body schema: application/json

The notification indicating that coupons were deleted via the Delete coupons endpoint.

TypeOfChange required	string Enum: "campaign_manager" "management_api" "rule_engine" The notification source, that is, it indicates whether the coupons were changed via one of the following routes: The Campaign Manager Management API Rule Engine
Operation required	string Enum: "CouponCreated" "CouponUpdated" "CouponDeleted" "AsyncCouponsCreated" "CouponsDeleted" "CouponsUpdated" The change (creation, update, or deletion) made to the coupons.
EmployeeName required	string The name of the employee who made the coupon-related changes. Note: This can be blank when the notication source is the Rule Engine.
NotificationType required	string Enum: "CouponCreated" "CouponUpdated" "CouponDeleted" "AsyncCouponsCreated" "CouponsDeleted" "CouponsUpdated" The type of notification.
BatchID required	string The ID of the batch to which the coupon belongs. Note: The Batch ID is generated when coupons are created. The Batch ID may be empty, for example, if all coupons in the campaign were updated.
ApplicationID required	number >= 1 The ID of the Application to which the coupon belongs.
CampaignID required	number >= 1 The ID of the campaign to which the coupon belongs.
TotalResultSize required	number >= 1 The number of deleted coupons.

Request samples

Payload

Content type

application/json

{"TypeOfChange": "campaign_manager",
"Operation": "CouponsDeleted",
"EmployeeName": "Franziska Schneider",
"BatchID": "nqylhnni",
"ApplicationID": 5,
"CampaignID": 3,
"TotalResultSize": 200
}

Expiring coupons Webhook

Request Body schema: application/json

The notification reminding users of expiring coupons.

TotalResultSize required	number [ 1 .. 1000 ] The number of expiring coupon notifications.
required	Array of objects <= 1000 characters The array of expiring coupon notifications.
NotificationType required	string Value: "CouponCodeExpiring" The type of notification.

Request samples

Payload

Content type

application/json

{"TotalResultSize": 1,
"Data": [{"CouponValue": "XMAS-20-2021",
"CreatedDate": "2024-07-24T14:15:22Z",
"ValidFrom": "2024-10-24T14:15:22Z",
"ValidUntil": "2024-12-24T14:15:22Z",
"CampaignId": 3,
"CustomerProfileId": "URNGV8294NV",
"UsageLimit": 100,
"UsageCounter": 10,
"BatchId": "32535-43255",
"Attributes": { }
}
],
"NotificationType": "CouponCodeExpiring"
}

Strikethrough pricing notifications

Represents the notifications about strikethrough pricing updates.

Strikethrough pricing updated Webhook

Request Body schema: application/json

The notification listing the changes in the pricing of your cart item catalog.

applicationId required	integer The ID of the Application that catalog items labels belongs to.
currentBatch required	integer The batch number of the notification. Notifications may be sent in different batches.
totalBatches required	integer The total number of batches for the notification.
required	object Information about the event that triggered the strikethrough labeling.
required	Array of objects The items that had their price updated.
NotificationType required	string Value: "StrikethroughPrice" The type of notification.

Request samples

Payload

Content type

application/json

{"applicationId": 322,
"currentBatch": 1,
"totalBatches": 10,
"trigger": {"id": 1,
"type": "CATALOG_SYNC",
"triggeredAt": "2020-06-10T09:05:27.993483Z",
"totalAffectedItems": 1500,
"payload": {"catalogId": 2,
"catalogVersion": 100
}
},
"changedItems": [{"id": 1,
"catalogId": 10,
"sku": "SKU1241028",
"version": 6,
"price": 99.99,
"evaluatedAt": "2020-06-10T09:05:27.993483Z",
"effects": [{"campaignId": 3,
"rulesetId": 11,
"ruleIndex": 2,
"ruleName": "Add 2 points",
"type": "setDiscountPerItem",
"props": {"name": "1EuroOff",
"value": 1
}
}
]
}
],
"NotificationType": "StrikethroughPrice"
}

Loyalty notifications

Represents the notifications about changes to loyalty points in profile-based loyalty programs.

Expiring points Webhook

Request Body schema: application/json

The notification reminding users that their active loyalty points will expire soon.

TotalResultSize required	number [ 1 .. 1000 ] The number of expiring points notifications.
required	Array of objects <= 1000 characters The array of expiring points.
NotificationType required	string Value: "LoyaltyPointsExpiring" The type of notification.

Request samples

Payload

Content type

application/json

{"TotalResultSize": 1,
"Data": [{"ExpiryDate": "2019-08-24",
"LoyaltyProgramID": 5,
"CustomerProfileID": "URNGV8294NV",
"AmountOfExpiringPoints": 10.99,
"SubledgerID": "sub-123"
}
],
"NotificationType": "LoyaltyPointsExpiring"
}

Added or deducted points Webhook

Request Body schema: application/json

The notification informing users when loyalty points are added or deducted.

ProfileIntegrationID required	string The integration ID of the customer profile to whom points were added or deducted.
LoyaltyProgramID required	integer >= 1 The ID of the loyalty program.
SubledgerID required	string The ID of the subledger within the loyalty program where these points were added.
Amount required	number The amount of added or deducted loyalty points.
Reason required	string The reason for the points addition or deduction.
TypeOfChange required	string Enum: "campaign_manager" "rule_engine" "management_api" The notification source, that is, it indicates whether the points were added or deducted via one of the following routes: The Campaign Manager Management API Rule Engine
EmployeeName required	string The name of the employee who added or deducted points.
UserID required	integer >= 1 The ID of the employee who added or deducted points.
Operation required	string Enum: "addition" "deduction" The action (addition or deduction) made with loyalty points.
StartDate required	string <date-time> The start date for loyalty points.
ExpiryDate required	string <date-time> The expiration date for loyalty points.
SessionIntegrationID required	string The integration ID of the session through which the points were earned or lost.
NotificationType required	string Enum: "LoyaltyPointsDeducted" "LoyaltyPointsAdded" The type of notification.

Request samples

Payload

Content type

application/json

{"ProfileIntegrationID": "URNGV8294NV",
"LoyaltyProgramID": 5,
"SubledgerID": "sub-123",
"Amount": 10.99,
"Reason": "Compensation",
"TypeOfChange": "campaign_manager",
"EmployeeName": "Franziska Schneider",
"UserID": 25,
"Operation": "addition",
"StartDate": "2023-01-24T14:15:22Z",
"ExpiryDate": "2024-01-24T14:15:22Z",
"SessionIntegrationID": "cc53e4fa-547f-4f5e-8333-76e05c381f67",
"NotificationType": "LoyaltyPointsDeducted"
}

Pending points Webhook

Request Body schema: application/json

The notification informing users that their pending points will become active soon.

TotalResultSize required	number [ 1 .. 1000 ] The number of pending points notifications.
required	Array of objects <= 1000 characters The array of pending points.
NotificationType required	string Value: "LoyaltyPointsPendingToActive" The type of notification.

Request samples

Payload

Content type

application/json

{"TotalResultSize": 1,
"Data": [{"LoyaltyProgramID": 5,
"SubledgerID": "SL001",
"CustomerProfileID": "URNGV8294NV",
"Points": 10.99,
"ActiveOn": "2023-08-20T12:22:00+02:00",
"ExpireOn": "2023-09-01T12:23:00+02:00",
"SessionIntegrationID": "cc53e4fa-547f-4f5e-8333-76e05c381f67"
}
],
"NotificationType": "LoyaltyPointsPendingToActive"
}

Tier upgrade Webhook

Request Body schema: application/json

The notification informing users when a loyalty tier upgrade occurs.

TotalResultSize required	number [ 1 .. 1000 ] The number of tier upgrade notifications.
required	Array of objects <= 1000 characters The array of tier upgrade notifications.
NotificationType required	string Value: "TierUpgrade" The type of notification.

Request samples

Payload

Content type

application/json

{"TotalResultSize": 1,
"Data": [{"CustomerProfileID": "URNGV8294NV",
"LoyaltyProgramID": 5,
"SubledgerID": "SL001",
"CurrentTier": "Silver",
"CurrentPoints": 120.55,
"OldTier": "Bronze",
"PointsRequiredToTheNextTier": 23.51,
"NextTier": "Gold",
"TierExpirationDate": "2023-12-01T12:23:00+02:00",
"TimestampOfTierChange": "2023-10-26T12:23:00+02:00"
}
],
"NotificationType": "TierUpgrade"
}

Tier downgrade Webhook

Request Body schema: application/json

The notification informing users when a loyalty tier downgrade occurs.

TotalResultSize required	number [ 1 .. 1000 ] The number of tier downgrade notifications.
required	Array of objects <= 1000 characters The array of tier downgrade notifications.
NotificationType required	string Value: "TierDowngrade" The type of notification.

Request samples

Payload

Content type

application/json

{"TotalResultSize": 1,
"Data": [{"CustomerProfileID": "URNGV8294NV",
"LoyaltyProgramID": 5,
"SubledgerID": "SL001",
"CurrentTier": "Silver",
"CurrentPoints": 120.55,
"OldTier": "Gold",
"TierExpirationDate": "2023-12-01T12:23:00+02:00",
"TimestampOfTierChange": "2023-10-26T12:23:00+02:00"
}
],
"NotificationType": "TierDowngrade"
}

Upcoming tier downgrade Webhook

Request Body schema: application/json

The notification reminding users of an upcoming loyalty tier downgrade.

TotalResultSize required	number [ 1 .. 1000 ] The number of upcoming tier downgrade notifications.
required	Array of objects <= 1000 characters The array of upcoming tier downgrade notifications.
NotificationType required	string Value: "TierWillDowngrade" The type of notification.

Request samples

Payload

Content type

application/json

{"TotalResultSize": 1,
"Data": [{"CustomerProfileID": "URNGV8294NV",
"LoyaltyProgramID": 5,
"SubledgerID": "SL001",
"CurrentTier": "Silver",
"CurrentPoints": 120.55,
"PointsRequiredToRemain": 23.51,
"NextTier": "Bronze",
"TierExpirationDate": "2023-12-01T12:23:00+02:00"
}
],
"NotificationType": "TierWillDowngrade"
}

Loyalty card notifications

Represents the notifications about changes to loyalty points in card-based loyalty programs.

Expiring points Webhook

Request Body schema: application/json

The notification reminding users that their active loyalty points will expire soon.

TotalResultSize required	number [ 1 .. 1000 ] The number of expiring points notifications.
required	Array of objects <= 1000 characters The array of expiring points.
NotificationType required	string Value: "LoyaltyCardPointsExpiring" The type of notification.

Request samples

Payload

Content type

application/json

{"TotalResultSize": 1,
"Data": [{"ExpiryDate": "2019-08-24",
"LoyaltyProgramID": 5,
"AmountOfExpiringPoints": 10.99,
"SubledgerID": "sub-123",
"CardIdentifier": "summer-loyalty-card-0543",
"UsersPerCardLimit": 5,
"Profiles": ["URNGV8294NV"
]
}
],
"NotificationType": "LoyaltyCardPointsExpiring"
}

Added or deducted points Webhook

Request Body schema: application/json

The notification informing users when loyalty points are added or deducted.

LoyaltyProgramID required	integer >= 1 The ID of the loyalty program.
SubledgerID required	string The ID of the subledger within the loyalty program where these points were added or deducted.
CardIdentifier required	string Loyalty card identification number.
UsersPerCardLimit required	integer The max amount of user profiles with whom a card can be shared. This can be set to `0` for no limit.
ProfileIntegrationIDs required	Array of strings The integration ID of the customer profile to whom points were added or deducted.
Amount required	number The amount of added or deducted loyalty points.
Reason required	string The reason for the points addition or deduction.
TypeOfChange required	string Enum: "campaign_manager" "rule_engine" "management_api" The notification source, that is, it indicates whether the points were added or deducted via one of the following routes: The Campaign Manager Management API Rule Engine
EmployeeName required	string The name of the employee who added or deducted points.
UserID required	integer >= 1 The ID of the employee who added or deducted points.
Operation required	string Enum: "addition" "deduction" The action (addition or deduction) made with loyalty points.
StartDate required	string <date-time> The start date for loyalty points.
ExpiryDate required	string <date-time> The expiration date for loyalty points.
SessionIntegrationID required	string The integration ID of the session through which the points were earned or lost.
NotificationType required	string Enum: "LoyaltyCardPointsDeducted" "LoyaltyCardPointsAdded" The type of notification.

Request samples

Payload

Content type

application/json

{"ProfileIntegrationIDs": ["yJSObdNNtOetCHWHPFuz",
"test-user-4zoj1c"
],
"LoyaltyProgramID": 5,
"SubledgerID": "sub-123",
"Amount": 10.99,
"Reason": "Compensation",
"TypeOfChange": "campaign_manager",
"EmployeeName": "Franziska Schneider",
"UserID": 25,
"Operation": "addition",
"StartDate": "2023-01-24T14:15:22Z",
"ExpiryDate": "2024-01-24T14:15:22Z",
"SessionIntegrationID": "cc53e4fa-547f-4f5e-8333-76e05c381f67",
"NotificationType": "LoyaltyCardPointsDeducted",
"CardIdentifier": "123-456-789ATBC",
"UsersPerCardLimit": 10
}