Skip to main content

Managing Application notifications

You can create notifications to be informed about the following events occurring within the Applications of your choice. Depending on the notification type, you can create one or more notifications of each type.

Notification typeEvent that triggers a notification
Campaign-related changes
Real-time
  • A campaign was:
    • Created
    • Edited, including changes made to:
    • Deleted
  • The state of a campaign changed.
  • One or more rules changed.
  • The evaluation for one or more campaigns changed.
Strikethrough pricing updates
Real-time
  • An item was added to a cart item catalog.
  • An item was updated in a cart item catalog.
  • The state of a campaign changed:
    • active to disabled
    • disabled to active
    • scheduled to active
  • A rule or cart item filter was updated.
  • A campaign expired.
  • Data was imported into a collection.
  • info

    Changes in collections trigger notifications only when the collections are used in strikethrough campaigns.

  • A campaign evaluation tree was edited.
  • info

    Editing a campaign evaluation tree will trigger notifications only if the strikethrough campaign is a part of the campaign evaluation tree.

  • A new strikethrough notification was created.
  • A strikethrough notification was activated.
  • The value of a custom attribute with associated entity Application or campaign was edited.
  • info

    If the strikethrough feature is enabled for a campaign, editing a custom attribute triggers a notification only when the attribute is used in the Rule Builder or in cart item filters.

Coupon-related changes
Real-time
  • A coupon was:
    • Created
    • Edited
    • Deleted
note
  • After a qualifying event occurs, a notification can take up to 5 minutes to be sent.
  • To learn about the loyalty-specific notification types, see Managing loyalty notifications.
  • Campaign-related changes:
    • Two requests are sent for the same notification: One for campaign evaluation tree changes, which occur at the Application level, and another for all other campaign-related events.
    • You cannot select which notifications to receive. Notifications are sent for all events and for all campaigns within an Application.
See Notification Schemas

Creating a campaign notification

Create campaign notifications to receive updates about campaign-related changes.

To create a campaign notification:

  1. Select the Application for which you want to set up campaign notifications.
  2. On the left-side menu, click Notifications.
  3. Click Create Notification > Campaign-related changes.
  4. In Notification name, type a name for the notification.
  5. In URL, type the URL where you want to receive notifications.
    tip

    To add another destination URL, create another notification.

  6. In Header, type a full HTTP header. For example: Content-Type: application/json.
  7. (Optional) Click Add header for each additional header value required by the receiving party, and enter the corresponding headers.
  8. Click Create Notification.
  9. Review the schemas of the notifications you will receive and parse them as required.

Creating a strikethrough pricing notification

Create strikethrough pricing notifications to receive updates about strikethrough pricing. When you create a strikethrough pricing notification, it is automatically activated.

important

You can create only one notification of this type.

To create a strikethrough notification:

  1. Select the Application for which you want to set up strikethrough pricing notifications.
  2. On the left-side menu, click Notifications.
  3. Click Create Notification > Strikethrough pricing updates.
  4. In Notification name, type a name for the notification.
  5. In URL, type the destination URL.
  6. In Header, type a full HTTP header. For example: Content-Type: application/json.
  7. (Optional) Click Add header for each additional header value required by the destination URL, and enter the corresponding headers.
  8. Click Create Notification.
  9. Review the schemas of the notifications you will receive and parse them as required.

Creating a coupon notification

Create coupon notifications to receive updates about coupon-related changes. When you create a coupon notification, it is automatically activated.

important

You can create only one notification of this type.

To create a coupon notification:

  1. Select the Application where you want to set up a coupon notification.
  2. On the left-side menu, click Notifications.
  3. Click Create Notification > Coupon-related changes.
  4. In Notification name, type a name for the notification.
  5. In the Notification sources section, specify which sources should trigger a notification:
  6. 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.
    • In Header, type a custom header that describes the request.
      • (Optional) Click Add header for each additional header value required by the receiving party, and enter the corresponding headers.
  7. Review the schemas of the notifications you will receive.
  8. Click Create Notification.

Deactivating a notification

To stop receiving updates from a notification, you can deactivate it. You can reactivate the notification at a later time.

important

Campaign notifications are active by default and cannot be deactivated. To stop receiving updates from a campaign notification, consider deleting it.

To deactivate a notification:

  1. On the left-side menu of the Application, click Notifications.
  2. To the right of the notification, toggle Active.
  3. In the confirmation window, click Deactivate Notification.
note

To reactivate a notification, follow the above steps, and in the confirmation window, click Activate Notification.

Editing a notification

You can edit the details of a notification at any time.

To edit a notification:

  1. Select the Application where you want to edit the notification.
  2. On the left-side menu, click Notifications.
  3. Click the edit symbol for the notification.
  4. Edit the required details, and click Save.

Deleting a notification

You can delete a notification to stop being notified about updates through a given route. To stop receiving updates but retain the notification, consider deactivating the notification instead.

To delete a notification:

  1. Select the Application where you want to delete a notification.
  2. On the left-side menu, click Notifications.
  3. Click next to the notification.
  4. In the confirmation pop-up that appears, click Delete Notification.