GuidesAPI ReferenceNotificationsDiscussionsSupportStatus

Manage Notifications

📘

Note

For information on how to manage notifications in Commerce Assistant, see Notifications *.

You can use the Notifications section in the Cleverbridge platform to add, view, edit, set up, and test automated notifications.

Add a Notification

  1. Enter information in the following sections and then click Save and Complete:

1. General

You can use the General section to enter these settings for a notification:

❗️

Warning

The transmission of data over the Internet or other networks involves certain security risks. Cleverbridge recommends performing an evaluation of your data protection requirements as well as a thorough risk analysis of the different transport layers available. Risk analysis determines which transport layer best meets your requirements for data confidentiality, integrity, and availability. For more information contact, contact Client Experience.

Name

Enter a unique name for the notification.

Transport Layer

Select a delivery method for the notification. The Transport Layer Details area displays different fields, depending on which transport layer you select.

📘

Note

SSL certificates for HTTPS and FTPS are only supported if they are signed by a trusted authority.

Email

An email containing transaction data files is sent to the selected contact. The data files are attached to the email. The subject line of the email includes a pre-defined prefix that reflects the notification type. For a list of the available prefixes, see Email Prefix column in the table in Notification Types.

The following options are available:

OptionDescription
ContactSelect the person who will receive the notification.
One email per itemClick the toggle to send separate email notifications for each item ordered in a cart, rather than one email containing information about all products in one purchase.

📘

Note

Email notifications are only transmitted if the receiving server supports SSL encryption.

FTPS Upload

FTP Secure Upload is an option to upload data to your FTP server using SSL cryptography. Enter the following information:

  • Server’s hostname
  • Destination directory for uploading the files
  • Username and password
HTTPS POST

HTTPS POST transfers encrypted transaction data based on an XML POST. With this type of transfer, the data itself (for example, the XML document) is the content of the POST data submitted with the POST request from Cleverbridge.

You can further protect the URL using basic web authentication (username and password). You can also protect this URL or server by limiting the IP ranges from which it can be accessed. Cleverbridge accesses from one of the following networks:

  • 185.55.69.129 – 185.55.69.158
  • 185.55.70.33 – 185.55.70.62
HTTPS POST (in Variable)

HTTPS POST is also available as a variable alternative, which submits the XML document as a regular POST variable called XML. With this method, the receiving script or code acts like it is receiving a POST submit from an HTML form, including an HTML TextArea with the name XML.

Example

You can use the following HTML code to test your receiving web server script:

<html>
  ...
  <body>
    <form action="https://yourserver/yourscript.xxx" method="post" enctype="multipart/form-data">
      <input type="file" name="file"><br>
      <input type="submit">
    </form>
  </body>
  ...
</html>
HTTPS Upload

You can use HTTPS Upload to upload the encrypted transaction data to your web server. This is accomplished by a POST request that is initiated using the same protocol as a web upload. For this option, you must enter the HTML page URL using https://.

You can further protect this URL using basic web authentication (username and password). You can also protect this URL or server by limiting the IP ranges from which it can be accessed. Cleverbridge accesses from one of the following networks:

  • 185.55.69.129 - 185.55.69.158
  • 185.55.70.33 - 185.55.70.62
SFTP Upload

Secure FTP Upload is an option to upload data to your FTP server using the SSH protocol. Enter the following information:

  • Server’s hostname
  • Destination directory for uploading the files
  • Username and password

📘

Note

These IP ranges used by Cleverbridge are subject to change, but we will alert you in advance of any change. Cleverbridge does not recommend implementing security based on restricting IP addresses because it only offers limited security and can create problems when requested changes cannot be completed in time. Cleverbridge offers proper authentication through usernames and passwords.

Active

If you want to deactivate the notification, you can do so by turning off the toggle. The system will then stop generating any notifications.

2. Settings

You can use the Settings section to select a document type and enter the settings for that document type.

Document Type

There are several formats for transmitting data in notifications:

  • JSON object
  • CSV file
  • Excel (not available for notifications with Transport Layer: Email)
  • Key value pair file (the INI file format)
  • XML document
  • Text (only available for notifications with Transport Layer: Email)
  • All (results in four attachments for every notification)

📘

Tip

Cleverbridge recommends basing any automated integration on the JSON object. The JSON object includes all transaction-related information. Also, JSON and XML specifications are regularly updated to add new data fields.

📘

Note

Cleverbridge regularly releases updated XML schema versions. If you use XML notifications, you must notify Client Experience that you need to be notified when the XML schema is updated. They email you for updates.

Enter Settings

a. In the Document Type drop-down list, select a format. The fields relevant to the selected format are displayed.

b. Select information in the following fields:

OptionDescription
IntervalDetermines how often the notifications are sent. Daily, weekly, and monthly notifications are only available for the transport layer delivery types FTP and HTTP Upload.
LanguageLanguage of the notification.
XML SchemaSelect the XML schema version. XML notifications can be generated so that they are compatible with newer or older versions of XML.
XML EncodingSelect the XML character set encoding type. The types are as follows:
- Unicode
- Unicode Unicode (UTF-8)
- Western European (ISO)

3. Notification Events

You can use the Notification Events section to configure the events that trigger a notification. You can configure notifications by product list and region, and then specify the event.

Product List

Optionally, select a product list to narrow the list of products that notifications are sent for. If no product list is selected, notifications are sent for all products.

Region

Optionally, select a region to narrow the locations that notifications are sent for. If no region is selected, notifications are sent for all regions.

📘

Note

The Subscription Commerce Manager provides a range of pre-defined, common regions you can use instead of configuring your own. The pre-defined regions are displayed at the bottom of region lists throughout the application and are preceded with the text h the text [**. To view what is included in the pre-defined regions, use the Regions search to find and view them.

Events

Select the events that trigger notifications. For a table that lists each notification event, along with its corresponding notification type, email prefix, and a short description, see Notification Types.

  1. Click Save and Complete.

Test a Notification

It is possible to try out our notifications. To do so:

  1. Select Tools > Notifications in the main menu of Subscription Commerce Manager.
  2. Click Add Notification and enter information in the following sections:
  • General
  • Settings
  • Notification Events

Make sure you select the check box Test order under Notification Events, and click Save and Complete.

  1. Use your test credit card in the checkout process. This will mimic the notification process and will allow you to explore our notifications.

📘

Note

This feature is only available for products and events for which you have configured an automated notification in the Notifications portal.

  1. In the main menu of the Commerce Assistant, select Transactions > Purchases. The Purchases search opens.
  2. Search for the purchase for which you want to send a notification manually.
  3. Right-click one or multiple items in the search result.
  4. Select Send Instant Notification. The notification is sent as configured by you in the Notifications portal.

Set Up Notifications for Subscriptions

Cleverbridge provides a comprehensive and powerful set of automated notifications that alert you about events such as the creation of new subscriptions or updates to existing subscriptions. It is important that you understand and utilize Cleverbridge notifications because they are essential to developing an effective and seamless integration between the Cleverbridge platform and your system.

To set up the notification events you need to sync our platform with your system and complete the following steps:

  1. Select Tools in the Main Menu of our web admin tool.

  2. Click Add Notification and configure the settings in the General section.

  3. Configure the settings in the Settings section.

  4. Choose a Product List and Region in the Notification Events section.

  5. Select the following Notification Events. These events are suitable for a majority of subscription use cases.

    • Paid
    • Subscription on hold
    • Subscription on grace
    • Subscription reinstated
    • Subscription deactivated
    • Subscription reminder charge
    • Subscription reminder payment expired
    • Subscription reminder offline payment
    • Subscription profile data changed
    • Subscription billing date extended

  6. Click Save and Complete.

For more information about the notifications Cleverbridge offers, see the Notification Guide.

Updated 10 months ago