Check out the new features, minor fixes, and updates we've made to our platform and APIsChangelog
Home >

Notification Types

cleverbridge offers different types of notifications. The notifications are based on events that are in turn configured to trigger automatic notification. The notification type is used as the file name and as the root element of the XML notification. The table below lists each notification type, along with its corresponding email prefix, event, and description.

Event Notification Type Description

Email

Prefix

Awaiting offline paymentOffline payment stands for a group of payment options. With the order confirmation, the customer receives a link with information on how to make the payment. Ordered products are delivered as soon as cleverbridge receives a payment confirmation from the payment provider.

NewOfflinePaymentPurchaseNotification

View JSON and XML examples

A new order has been placed using an offline form of payment, such as PayPal or wire transfer. [WOF]
Paid

PaidOrderNotification

View JSON and XML examples

A customer has placed an order and payment has been received by cleverbridge. This notification is sent when payment is received for online or offline payments. [PAY]
Purchase order

NewPurchaseOrderNotification

View JSON and XML examples

A customer has placed a new order using a purchase order. This order is fulfilled prior to payment being received. [WPO]
Registration

RegistrationNotification

View JSON and XML examples

A customer has registered for a product/service and a free order has been created. [REG]
Refunded

RefundNotification

View JSON and XML examples

A full refund has been issued. The total gross price of the order has been refunded back to the customer. [REF]
Partially refunded

PartialRefundNotification

View JSON and XML examples

A partial refund has been issued. A portion of an order/service has been refunded back to the customer. [REF]
Chargeback

ChargebackNotification

View JSON and XML examples

cleverbridge received a notification from our credit card processor that the customer is disputing the purchase. [CHB]
Payment declined

OnlinePaymentDeclined

View JSON and XML examples

A payment has been declined. [DEC]
Returned direct debit

ReturnDirectDebitNotification

View JSON and XML examples

A return of a direct debit has been issued for the amount paid using the direct debit payment method. [CHB]
Test order

PaidOrderNotification

View JSON and XML examples

A test order has been placed in the cleverbridge system using a test credit card. [PAY]
New quote

QuoteNotification

View JSON and XML examples

A customer has requested a price quote. [QUO]
Awaiting release

AwaitingNotification

View JSON and XML examples

An order has been placed that needs to be accepted by you before it can be processed. [AWR]

Customer contact data changed

CustomerContactDataChangedNotification

View JSON and XML examples

The customer's data has been updated for a specific order. New customer data is sent in this notification. [CDC]
Subscription on hold

RecurringBillingOnHoldNotification

View JSON and XML examples

The grace period is over and the subscription is still not paid. The customer must complete payment in the next few days or the subscription will be deactivated. [RCH]
Subscription on grace

RecurringBillingOnGraceNotification

View JSON and XML examples

The payment for a subscription is due but could not be processed with the current payment details. The customer must update the payment details to complete the renewal or the subscription will be deactivated. [RCH]
Subscription reinstated

RecurringBillingReinstatedNotification

View JSON and XML examples

The subscription has been reactivated, and the customer will be expected to remit payment at the time of the next rebilling event. [RCA]
Subscription deactivated

RecurringBillingCanceledNotification

View JSON and XML examples

The customer's subscription has been canceled and he will not be rebilled at the next billing interval. This does not mean a refund has been issued for the current billing interval. [RCC]
Subscription reminder charge

SubscriptionReminderChargeNotification

View JSON and XML examples

A reminder that the subscription renewal is approaching for online payments. [RCR]
Subscription reminder payment expired

SubscriptionReminderPayOptExpNotification

View JSON and XML examples

The payment of the subscription of the product is due but the credit or debit card used in the previous transaction will expire before the payment due date. [RPE]
Subscription reminder offline payment

SubscriptionReminderOfflinePayNotification

View JSON and XML examples

A reminder that a renewal is upcoming. This is sent for orders placed with offline payment methods. The default is seven days prior to renewal. [ROP]
Subscription profile data changed

CustomerProfileUpdateNotification

View JSON and XML examples

A customer has changed his profile data for a subscription, for example the payment details. [CPU]
Subscription billing date extended

SubscriptionBillingDateExtended

View JSON and XML examples

The billing date for a customer's subscription has been changed or extended. [BDE]
New affiliate

NewAffiliateSignup

View JSON and XML examples

A new affiliate has signed up through the cleverbridge platform and has to be reviewed prior to being accepted. [NAF]
New partner

NewPartnerSignup

View JSON and XML examples

A new partner has signed up through the cleverbridge platform and has to be reviewed prior to being accepted. [NPA]
Error

ErrorNotification

Note

The data that you receive depends on the type of error that occurs. For example, if a customer successfully pays for a product, but an error occurs during the license key generation, then cleverbridge sends an email notification with the following subject line: "[ERR] #123456789: Error creating license key for cleverbridge". However, since the transaction was successful, a PaidOrderNotification is attached.

An error occurred when trying to generate a license key, trying to send a notification, trying to process a payment, or trying to integrate with Salesforce. See the Error Log in the Commerce Assistant for more information. [ERR]
Subscription renewal type changed

SubscriptionRenewalTypeChangedNotification

View JSON and XML examples

A customer changed the subscription renewal type (automatic or manual). Subscription