Managing Application notifications
Application notifications allow you to be informed about the changes occurring to your campaigns and coupons. Requests from the notifications you create are sent as webhooks.
To learn about notifications for loyalty programs, see Managing loyalty notifications.
Notification types
A notification type represents a qualifying Application-related event for which you can create a notification and receive requests, for example, coupons that are expiring soon.
You can create and manage notifications of the following types:
Notification type | Description |
---|---|
Campaign-related changes Real-time | Be notified of the following events in real time:
note
|
Strikethrough pricing updates Real-time | Be notified of the following events in real time:
important You can create only one notification of this type. |
Coupon-related changes Real-time | Be notified in real time when a coupon is created, edited, or deleted. important You can create only one notification of this type. |
Expiring coupons Scheduled | Be notified through scheduled triggers when a coupon is close to expiration. A request is sent for every expiring coupon whose campaign is Running. For each notification you create, you can add up to three triggers, each with a different alert time before coupon expiration. important You can create only one notification of this type. |
- With Real-time notifications, it can take up to five minutes to send requests after a qualifying event occurs.
When an update cannot be sent because of server errors (5xx
response codes) or
429 Too Many Requests
, resend attempts are made for a maximum of 10 minutes
with more time passing between each attempt.
See Notification Schemas
Notification batching
For notifications where batching is possible, the data for multiple qualifying events is batched into a single request by default to optimize the use of hardware resources:
- For Campaign-related changes, the data for up to five campaigns is batched into a single request.
- For Strikethrough pricing updates:
- The data for up to 1000 updates is batched into a single request. To have this batching threshold configured for individual deployments, contact your Customer Support Manager.
- Requests are generated sequentially. Talon.One waits for the response of a request before sending the next one.
- For Expiring coupons, the data for up to 1000 coupons is batched into a single request.
- For Coupon-related changes, when there are more than 1000 coupons, only the batch ID of the coupons is included in the request, and no further requests are sent.
Creating an Application notification
You can create notifications for each of your Applications. When you create a notification, it is automatically activated.
To create an Application notification:
-
For Strikethrough pricing updates only: Ensure you have created a strikethrough rule in the Application.
-
In Apps, select the Application for which you want to create a notification.
-
On the left-side menu of the Application, click Notifications.
-
Click Create Notification.
-
In the Create Notification drawer, select the type of notification to create.
-
In Notification name, type a name for the notification.
-
For Coupon-related changes only:
In the Notification sources section, specify which sources should trigger a notification:
- Campaign Manager: Notify only when coupons are created, updated, or deleted through the Campaign Manager.
- Management API: Notify only when one of the following endpoints is called:
- Rule Engine: Notify only when coupon changes occur
as the result of one of the following coupon-related API effects:
- couponCreated effect
- updateAttribute effect
-
For Expiring coupons only:
In the Schedule section, specify how long before coupon expiration you want to trigger alerts:
- Amount: Number of days or weeks.
- Period: Days or weeks.
note- On the scheduled trigger day, requests are sent at 00:00 hours UTC.
- To include coupons that expire in the following 24 hours,
schedule a trigger for
0
day(s) before expiration.
-
In the Request section, specify the details of the webhook request:
- Verb indicates the HTTP request method:
POST
. - In URL, type the URL where you want to receive the notification.
- (Optional) In Header, type a custom header that describes the request.
For example:
Content-Type: application/json
.- (Optional) Click Add header for each additional header value required by the receiving party, and enter the corresponding headers.
- Verb indicates the HTTP request method:
-
In the Payload preview section: If the Batching option is available, choose whether you want to leave it enabled or disable it.
- Review the request payload. See the notification schemas.
-
(Optional) To validate the URL and headers you entered by sending a test request, click Test Notification.
-
Click Create Notification.
Deactivating an Application notification
To stop receiving requests from an Application notification, you can deactivate it. You can reactivate the notification at a later time.
To deactivate an Application notification:
- On the left-side menu of the Application, click Notifications.
- To the right of the notification, toggle Active.
- In the confirmation window, click Deactivate Notification.
To reactivate a notification, follow the above steps, and in the confirmation window, click Activate Notification.
Editing an Application notification
You can edit the details of an Application notification at any time.
To edit an Application notification:
- Select the Application where you want to edit the notification.
- On the left-side menu, click Notifications.
- Next to the notification you want to edit, click .
- Edit the required details, and click Save.
Deleting an Application notification
You can delete an Application notification to stop receiving requests through a given route. To stop receiving requests but retain the notification, consider deactivating the notification instead.
To delete an Application notification:
- Select the Application where you want to delete a notification.
- On the left-side menu, click Notifications.
- Next to the notification you want to delete, click .
- In the confirmation pop-up that appears, click Delete Notification.