Skip to main content

Add a notification

In our web admin tool:

Step 1: Add a new notification​

Go to Configure > Tools > Notifications, then select the Add Notifications button.

Step 2: General tab​

In the General tab, fill in:

Name: Enter a unique name for the notification. Keep the name readable and explanatory.

If the notification is ready to be used, make sure that the Active toggle is enabled.

Step 3: Choose Transport Layer​

Caution

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 Client Experience.

note

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

The following transport layers are available:

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 predefined prefix that reflects the notification type. For a list of the available prefixes, see Notification Types.
    note

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

    • Transport Layer Details include:
      • Contact: The person who will receive the notification.
      • One email per item: If the toggle is enabled, we will send separate email notifications for each item ordered in a cart, rather than one email containing information about all products in one purchase.

FTPS upload​

  • FTP Secure Upload is an option to upload data to your FTP server using SSL cryptography.
    • Transport Layer Details include:
      • Server: Server hostname.
      • Directory: Destination directory for the files upload.
      • Username and Password: Credentials used to connect to the server

HTTP POST​

Selecting HTTP POST allows data transmission over both HTTP and HTTPS transport layers. This method transfers encrypted transaction data using an XML POST request. In this setup, the data itself (such as an XML document) is included as the POST payload when Cleverbridge submits the request.

  • Transport Layer Details:
    • Define the URL for the transfer.
    • 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.

Check IPs to add to your allowlist.

HTTP POST (in Variable)​

The HTTP POST option is also available as a variable alternative for both HTTP and HTTPS transport layers. It 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.

HTTP POST (inVariable) Example​

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

HTTP upload​

The HTTP Upload option enables secure transfer of encrypted transaction data to your web server via a POST request, similar to a standard web upload. While HTTPS is recommended for security, HTTP can also be used. To configure this option, specify the target URL starting with http:// or https://.

  • Transport Layer Details:
    • Define the URL for the transfer.
    • You can further protect the URL using basic web authentication (Username and Password).

Check IPs to add to your allowlist.

SFTP upload​

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

  • Transport Layer Details include:
    • Server: Server hostname.
    • Directory: Destination directory for the files upload.
    • Username and Password: Credentials used to connect to the server

IPs to add to your allowlist​

IP ranges for networks Cleverbridge uses for key generator calls or notifications:

NetworkNetmask
91.242.212.0255.255.255.224
93.94.129.32255.255.255.224
185.55.69.128255.255.255.224
185.55.70.32255.255.255.224

Step 4: Transport Layer Details​

Select the notification delivery method and its details. The Transport Layer Details area varies subject to the chosen transport layer.

Step 5: Settings​

Select a document type and define corresponding settings.

Document type​

The following document types are available to transmit data in notifications:

  • All: Available only for notifications with Transport layer: Email.
  • CSV file
  • Excel: Not available for notifications with Transport layer: Email.
  • JSON object: Cleverbridge recommends basing any automated integration on the JSON.object. The JSON object includes all transaction-related information.
  • Key value: Key value pair file in the INI file format.
  • Text: Only available for notifications with Transport layer: Email
  • XML: Cleverbridge regularly releases updated XML schema versions. If you use XML notifications, let Client Experience know that you need to be notified when the XML schema is updated.
note

The list of settings depends on the chosen Document Type.

Interval​

Determines how often the notifications are sent. Daily, weekly, and monthly notifications are only available for the transport layer delivery types FTP and HTTP Upload.

Character Encoding​

Select the character set encoding type. The options are:

  • Unicode
  • Unicode (UTF-8)
  • Western European (ISO)

Language​

Select the language of the notification.
To find out more about managing languages, go to Manage languages.

Step 6: Notification Events​

Switch to the Notification Events tab to configure the events that trigger a notification. You can define the product list and region to which the notifications apply and specify the notification 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.
    tip

    Commerce Assistant provides a range of predefined, common regions you can use instead of configuring your own. The predefined regions are displayed at the bottom of region lists throughout the application and are preceded with the text [cleverbridge]. To view what is included in the predefined 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.

Set up notifications for subscriptions​

To set up the notification for subscriptions, select from 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

Test a notification​

It is possible to try out our notifications. To do so select the Test order in the Notification Events dropdown.

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

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


Did you find this doc useful?