Notification Types
Cleverbridge offers different types of notifications. The notifications are based on events that in turn are configured to trigger automatic notifications. The notification type is used as the file name and in the meta-object under type in the JSON notification or as the root element of the XML notification, respectively. The table below lists each notification type, along with its corresponding email prefix, event, and description.
Important
The table below includes information on the notifications in Subscription Management 1.0 and 2.0. The Subscription Renewal Type Changed notification applies to Subscription Management 2.0 only. If you are unsure which version you are on, contact Client Experience.
| Event | Notification Type | Description | Email Prefix |
|---|---|---|---|
| Awaiting offline payment | NewOfflinePaymentPurchaseNotification View JSON and XML examples | A new order has been placed using an offline payment method, such as wire transfer, money order, or check. | [WOF] |
| Paid | PaidOrderNotification View JSON and XML examples | A customer has successfully executed the payment for the placed order. This notification is sent when the payment is received for online and offline payments alike. | [PAY] |
| Purchase order | NewPurchaseOrderNotification View JSON and XML examples | A customer has placed a new order by using an invoicing method. This order is fulfilled prior to the reception of the payment. | [WPO] |
| Registration | RegistrationNotification View JSON and XML examples | A customer has registered for a product or a service, and a free order has been created. | [REG] |
| Refunded | RefundNotification View JSON and XML examples | A full refund has been issued for the purchase. The total gross amount of the order or the service has been paid back to the customer. | [REF] |
| Partially refunded | PartialRefundNotification View JSON and XML examples | A partial refund has been issued for the purchase. A portion of the total amount of an order or service has been paid back to the customer. | [REF] |
| Chargeback | ChargebackNotification View JSON and XML examples | Cleverbridge received information from our credit card processor that a customer is disputing a purchase and has initiated a chargeback. There are two types of notifications that relate to chargebacks: ChargebackNotification ChargebackInformationRequestNotification To receive both notifications, you must set up two separate notifications in the Cleverbridge platform under Tools > Add Notifications. In the first notification, select Chargeback under Notification Events. In the second notification, select Chargeback information request under Notification Events. If you create one notification with both of these events, you will not receive the ChargebackInformationRequestNotification. | [CHB] |
| Payment declined | OnlinePaymentDeclined View JSON and XML examples | A payment for an initial order or a subscription renewal 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 for your product. | [QUO] |
| Awaiting release | AwaitingNotification View JSON and XML examples | An order has been placed and you need to accept it 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 grace | RecurringBillingOnGraceNotification View JSON and XML examples | The payment for a subscription is due but could not be processed with the available payment details. The customer must update the payment information to process the renewal or the subscription will be deactivated. | [RCH] |
| Subscription on hold | RecurringBillingOnHoldNotification View JSON and XML examples | The granted grace period has ended without payment received for the subscription. The customer must execute payment in the next few days or face the risk of subscription deactivation. | [RCH] |
| Subscription reinstated | RecurringBillingReinstatedNotification View JSON and XML examples | The subscription has been reactivated and the customer is expected to execute payment on the next billing date. | [RCA] |
| Subscription deactivated | RecurringBillingCanceledNotification View JSON and XML examples | The subscription has been canceled, either online by the customer or by a customer support specialist. As a result, the customer will not be re-billed on the next billing date. When you receive the RecurringBillingCanceledNotification, contact the customer by email and offer them the option to manually renew the subscription before the next billing date. If the customer does not want to renew the subscription, be sure to deactivate the customer's license so its validity is not extended. | [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 for subscription renewal is due but the credit or debit card used in previous transactions will expire before the next billing date. Be sure to send a change payment link to the customer in order for them to update the data before the payment due date. | [RPE] |
| Subscription reminder offline payment | SubscriptionReminderOfflinePayNotification View JSON and XML examples | This is a reminder for an upcoming renewal that is limited to orders placed with offline payment methods. The default setting is seven days prior to the renewal date. | [ROP] |
| Subscription profile data changed | CustomerProfileUpdateNotification View JSON and XML examples | The profile data for a subscription was modified. For example, payment details. | [CPU] |
| Subscription billing date extended | SubscriptionBillingDateExtendedNotification 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 The data 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 during one of the following scenarios: while generating a license key - while generating a license key, - while trying to send a notification, - while processing a payment, - while trying to integrate with Salesforce. See the Error Log in the Cleverbridge platform in order to find out if further action is required on your part. | [ERR] |
| [Applicable for Subscription Management 2.0] Subscription renewal type changed | SubscriptionRenewalTypeChangedNotification View JSON and XML examples | A customer changed the subscription renewal type (automatic or manual). | [PAY] |
| Chargeback information request | ChargebackInformationRequestNotification View JSON and XML examples | Cleverbridge has decided to fight a chargeback request. Therefore, we need you to provide us with additional information to help us fight it. This notification is delivered via email. Be sure to set up a Contact as the email recipient who can provide Cleverbridge with the information that we require. For more information about email notifications and contacts, see Manage Notifications. There are two types of notifications relating to chargebacks: - ChargebackNotification - ChargebackInformationRequestNotification To receive both notifications, you must set up two separate notifications in the Cleverbridge platform under Tools > Add Notifications. In the first notification, select Chargeback under Notification Events. In the second notification, select Chargeback information request under Notification Events. If you create one notification with both of these events, you will not receive the ChargebackInformationRequestNotification. | [CIR] |
| Awaiting release for purchase order | AwaitingReleaseForPurchaseOrderNotification View JSON and XML examples | A customer has placed a purchase order and must now confirm it by fax, letter, or email. Following the confirmation, either Cleverbridge or the client must approve the order in the Cleverbridge platform. | [APO] |
| VAT refunded | VatRefundNotification View JSON and XML examples | A VAT, GST, or sales tax refund has been issued. A business customer contacted our customer support team and requested a refund of the tax paid on an order. After checking the necessary information, such as the VAT identification number, a customer support specialist processed the refund. | [REF] |
| Secure 3D enrolled | Secure3DEnrolledNotification View JSON and XML examples | A purchase or recurring payment requires strong customer authentication (SCA) and the customer has not yet authenticated the payment with their bank. Cleverbridge will process the purchase when the customer has successfully completed the authentication process. The notification allows you to track the impact of SCA on your business and launch targeted marketing campaigns. | [SCA] |
Updated 29 days ago