Skip to main content

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 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:

Be notified of the following events in real time:

  • A campaign was created, edited, or deleted.

    Editing includes changes made to mandatory attributes or the Settings section of any campaign.

  • The state of a campaign changed.

  • One or more rules changed.

  • The evaluation for one or more campaigns changed.

note
  • Requests are sent for all the above events and for all the campaigns of the Application. You cannot select which requests to receive.
  • Requests are categorized by campaign. For example, if a qualifying event occurs in two campaigns, a request for each of those campaigns is sent.
  • A separate request is sent if the campaign evaluation tree changes.

You can create one or more notifications of this type. Requests are sent every five minutes. This means:

  • A request can take up to five minutes to be sent after a qualifying event occurs.
  • If a qualifying event occurs repeatedly in that interval, the request reflects the latest effective change. For example, if a campaign is activated, disabled, and activated again in that interval, the request reflects only one activation event.

Strikethrough pricing updates Real-time​

Be notified of the following events in real time:

  • A cart item catalog was updated via the Sync cart item catalog endpoint, and the update triggered at least one strikethrough rule.
  • A rule or cart item filter was updated.
  • A campaign became Expired or its state changed:
    • Running ⇨ Disabled
    • Disabled ⇨ Running
    • Scheduled ⇨ Running
  • A strikethrough notification was created or activated.
  • Data was imported into a collection, when the collections are used in Running campaigns containing strikethrough rules.
  • A campaign evaluation tree was edited, when a campaign containing strikethrough rules is a part of the campaign evaluation tree.
  • A campaign evaluation group was changed, when the campaign is Running and contains strikethrough rules.
  • The value of a custom attribute with associated entity Application or campaign was edited, when the attribute is used in one of the following places of a Running campaign:
    • A strikethrough rule.
    • A cart item filter.
    • The payload of a per-item custom effect that is referenced in a strikethrough rule.
  • The payload of a per-item custom effect was edited.
  • The API name of a per-item custom effect was changed, when the effect is referenced in a strikethrough rule of a Running campaign.
  • The name, currency, or time zone setting of an Application was changed in the Application settings, when it is referenced in a strikethrough rule of a Running campaign.

You can create only one notification of this type. Requests are sent every five seconds.

Be notified in real time when a coupon is created, edited, or deleted, whether it happens through the Campaign Manager, Management API, or the Rule Engine. However, this does not include imported coupons.

You can create only one notification of this type. Requests are sent immediately after a qualifying event occurs.

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.

You can add up to three scheduled request triggers, each with a different alert time before coupon expiration.

You can create only one notification of this type.

See Notification Schemas

Batching and delivery​

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.

All notification types have a response timeout of 10 seconds. Requests that time out are logged with no response code.

Retry policy

When a request 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.