Third-Party Integrations

It is possible to integrate the Cleverbridge platform with a variety of third-party applications. The following describes how to integrate with the most relevant applications in different fields.

Sales

Integrating a customer relationship management (CRM) platform enables you to seamlessly import and synchronize your customers' data from/with the Cleverbridge platform. The integration also allows you to automate your sales workflow and provide specifically targeted reporting. You can integrate with the following CRM platform:

Salesforce

๐Ÿšง

Important

Salesforce Integration via the Commerce Assistant is no longer maintained. To integrate Salesforce with our subscription commerce platform, use our Two-Way Salesforce Integration below.

Cleverbridge offers integration support for Salesforce, the leading customer relationship management (CRM) platform for sales, service, and marketing.

Two-Way Salesforce Integration

Our Integration Services allow B2B companies to automate their sales so that their sales reps become more efficient and can focus on higher-value selling. They sync customer data in real-time bi-directionally between Salesforce and our subscription commerce platform.

๐Ÿ“˜

Example

Here are a few examples of what you can achieve with the integration:

  • Create and update lead, contact, account, order, quote, and opportunity data in Salesforce based on transactions processed in our subscription commerce platform
  • Populate and process carts directly from Salesforce transaction objects such as Opportunities, Quotes, and Orders
  • Integrate with Salesforce CPQ for a seamless online buying experience for your customers
  • Create and manage subscribers and subscriber lists in Salesforce Marketing Cloud based on changes made in our subscription commerce platform

The integration consists of two easy steps:

  1. Cleverbridge sets up Integration Services for you, which includes connecting your Salesforce account with your Cleverbridge account and choosing a usage scenario.
  2. You get access to TIBCO Scribeยฎ Online, where you can map Salesforce entities/fields to Cleverbridge entities/fields and vice versa. For this part of the integration, documentation is available at Cleverbridge Connector for TIBCO Scribeยฎ Online under https://help.scribesoft.com/scribe/en/index.htm#sol/conn/cleverbridge.htm.
    For more information on our subscription commerce platform and its Salesforce integration, contact Client Experience.

TIBCO Scribe

You can use our TIBCO scribe connector to integrate data into lead, contact, account, and opportunity data in CRM systems or create subscribers and manage subscriber lists in marketing systems.

For more information, see the Cleverbridge Connector For TIBCO Scribeยฎ Online.

Marketing

Integrating a partner management platform enables you to analyze and monitor your digital campaigns in a cost and time-effective manner. The integration also helps you to plan effective marketing strategies, which allows you to improve your conversion rate and grow your client base. You can integrate with the following partner management platform:

Partnerize

To integrate with Partnerize, with whom we partnered to provide our Performance Marketing Platform, you must set up the following:

Partnerize Integration Cookie

Whenever a publisher has been accepted into your Partnerize campaign to promote your product(s), the publisher receives links to your web page(s) in the Partnerize console. An x-parameter (&x-clickref) is appended to each of these links, and the unique value of this x-parameter is tied to the corresponding publisher (&x-clickref=[unique value]).

To integrate with the Partnerize platform, you need to generate a first-party (.yourdomain.com) cookie that will record the unique value contained in the Partnerize x-parameter. Whenever customers land on your web pages from Partnerize publisher links, you should drop this cookie onto their web browsers. If a customer reaches a Cleverbridge-hosted checkout process and decides to make a purchase, we will attribute the sale to the value saved in the cookie. Then we will make a call to the Partnerize API with the applicable purchase details, including the clickref value.

๐Ÿ“˜

Note

This is how Partnerize learns that a publisher drove traffic to your site that resulted in a sale. Partnerize bases their commission calculations on this information.

The cookie that you set up to collect this information should have the following characteristics:

  • It only saves the value of the x-clickref.
  • It must be named something standard and unique to your company, such as partnerize_clickref_[yourname].
  • It should be set up to expire. It is recommended setting it up to expire 90 days after the time of the first click.

๐Ÿšง

Important

If you use multiple ecommerce providers, make sure that all incoming traffic with &x-clickref=[value] ends up in the Cleverbridge-hosted checkout process.

Partnerize X-Parameters

To enable Cleverbridge to correctly credit the Partnerize publishers who distribute your promotional coupon codes through mailings, print media, web forums, etc., you have to set up x-parameters in the Commerce Assistant that contain the publishers' ID information. Whenever promotional purchases are completed, Cleverbridge uses these x-parameters to trigger API calls, which in turn pass the relevant publisher ID(s) on to the Partnerize platform.

To set up your Partnerize x-parameters, complete the following steps:

  1. Select Marketing > Promotions in the main menu of the Commerce Assistant.
  2. Search for and open the promotion your Partnerize publishers are distributing your coupon codes for.
  3. Select the General tab in the Promotion portal and enter one x-parameter in the X-parameters field. The x-parameter key-value pair must have the following format:
    x-publisher-id=<partnerize publisher ID>

๐Ÿ“˜

Example

x-publisher-id=130l392

๐Ÿ“˜

Note

An active integration with a Partnerize campaign is required to use this field.

  1. (Optional step) To find the Partnerize Publisher ID for a publisher in your Partnerize account, complete the following steps:
    a. Click the Partners tab in the main menu of Partnerize.

b. Select Status > Approved as a filter in the left column.

c. Select Download CSV in the Actions drop-down list. A CSV file is downloaded.

d. Open the CSV file and find the publisher(s) you would like to credit. In column E, you can find their Partnerize Publisher ID.

  1. Click Save.
    For more information about the Partnerize onboarding process, see Getting Started with Partnerize.

Tracking

Tracking tools can help you track user activity and develop a better design for your website. You can also use tracking tools to test your website design and identify trending products. You can integrate your website with any tracking tool using the following tag management platform:

Google Tag Manager

You can use Google Tag Manager (GTM) to manage third-party tracking tools and custom data integrations on your own. As a result, this tool gives you the freedom to trigger your tracking codes on the Cleverbridge checkout pages directly, without having to set up trackings in the Cleverbridge Commerce Assistant.

To integrate the Google Tag Manager with your Cleverbridge checkout pages, do the following:

1. Sign up for a GTM Account

For more information, go to https://tagmanager.google.com/.

2. Ask Cleverbridge to enable the Data Layer required by GTM on your checkout pages

To do so, contact the Client Experience team at [email protected].

3. Set up your GTM tags using the Cleverbridge data Layer and Events

In the following sections, you can learn about Cleverbridge dataLayer, as well as the enhanced e-commerce events that you can consume in your GTM tags:

About the Cleverbridge Data Layer

The Cleverbridge dataLayer is added to every page of your checkout process when GTM is enabled. This dataLayer contains information about the cart, session, user, and transaction, all of which you can dynamically insert in your GTM tags. The dataLayer is activated upon every page load, but it can also contain additional information related to certain events. For more information, see Events and the Cleverbridge data Layer.

Information Available in the Data Layer on Page Load

The following information is available upon every page load of your checkout process if GTM is enabled for your account. The values are inserted dynamically based on the current user session.

dataLayer = [{
  'transactionId': '51142586',                                  // the purchase reference ID
  'transactionAffiliation': 'cleverbridge',                     // source of the purchase
  'transactionTotal': 53.95,                                    // the total of the transaction revenue
  'transactionTax': 8.61,                                       // the VAT of the transaction
  'transactionShipping': 0,                                     // the shipping cost of the transaction
  'transactionCurrency':  'EUR',                                // the transaction currency ID
  'transactionProducts': [{
    'id' : '2417',                                              // the Cleverbridge product ID
    'sku' : 'my internal sku',                                  // your internal SKU
    'category' : 'Software',                                    // the product category
    'name' : 'Anti-Malware+%5b2+Years%5d',                      // the product name
    'price' : '53.95',                                          // the product price, gross or net
    'quantity' : '1'                                            // the product item quantity
  }],
  'customerCurrency':  'EUR',                                   // the transaction currency ID
  'languageCountry': 'en-DE',                                   // the customerโ€™s locale
  'coupons' : 'OFF50',                                          // coupon code (optional)
  'cleverbridgePage' : 'confirmation.successInstantDelivery',   // page name and detail
  'paymentStatus': 'paid ',                                     // the status of the purchase (*)
  'random' : 'rmgP9A3fUMNxANgeuHi8',                            // a unique hash per session
  'configParameterName' : 'default',                            // the value of cfg= parameter
  'paymentType' : 'CCA_VIS ',                                   // the payment type (*)
  'x-parameter' : [{                                            // an array of custom x-parameters
    'x-parameter' : 'customValue'
  }]
}];

* paymentStatus โ€” Possible values are paid, waiting for payment, quote, or test purchase.
* paymentType โ€” For possible values, see Payment Result.

๐Ÿ“˜

Note

Some fields may have empty values if dynamic values are not available on the current page. For example, a value for transactionId would not be available on the checkout page or review page before the purchase is completed.

How to Read the Information in the Data Layer in GTM

To access the dataLayer values in your GTM tags, you must create a new user-defined variable in your GTM account for each field you want to track. For more information, see User-defined variables.

๐Ÿšง

Important

When creating a new variable, be sure to select type Data Layer Variable in the Variable Configuration area.

๐Ÿ“˜

Example

The following user-defined variable is called cleverbridgeTransactionId. If the variable is used, the user is able track the value of transactionId in the dataLayer.

To track the variable in GTM tags, the user inserts {{cleverbridgeTransactionId}}.

Events and the Cleverbridge data Layer

In certain situations, events containing additional data are added to the dataLayer. You can use these event occurrences as GTM tag triggers. Currently, the following events are available for GTM integration:

cartOpen example
This event is triggered when the customer enters the checkout process for the first time.

dataLayer.push({
  'event': 'cartOpen',
  'ecommerce': {
    'currencyCode': 'EUR',
    'add': {
      'actionField': {
        'affiliation': 'cleverbridge',
        'step': 1
      }
      'products': [ {
        'id': '2417',
        'name': 'Anti-Malware+%5b2+Years%5d',
        'price': '53.95',
        'brand': 'brandValue',
        'category': 'categoryValue',
        'variant': 'variantValue',
        'quantity': 1,
        'list': 'listName'
      }],
      'impressions': [ {
        'id': "71028",
        'name': "Recommended Professional",
        'price': "12.95",
        'category': "Consumer Support",
        'variant': "variantValue",
        'position': 1,
        'list': "listName"
      }]
    }
  }
});

checkout example
This event is triggered when the customer continues in the checkout process.

dataLayer.push({
  'event': 'checkout',
  'ecommerce': {
    'currencyCode': 'EUR',
    'checkout': {
      'actionField': {
        'step': 1
      },
      'products': [ {
        'id': '2417',
        'name': 'Anti-Malware+%5b2+Years%5d',
        'price': '53.95',
        'brand': 'brandValue',
        'category': 'categoryValue',
        'variant': 'variantValue',
        'quantity': 1,
        'list': 'listName'
      }],
      'impressions': [ {
        'id': "71028",
        'name': "Recommended Professional",
        'price': "12.95",
        'category': "Consumer Support",
        'variant': "variantValue",
        'position': 1,
        'list': "listName"
      }]
    }
  }
});

๐Ÿ“˜

Note

The field step indicates the step of the checkout process where the customer is currently active. Depending on your design and region, your checkout process may contain multiple steps (cart page, billing details, review page, etc.).

removeFromCart example
This event is triggered when a customer removes a product from the cart. The event occurs as soon as the customer clicks the Remove button and before the page reloads.

dataLayer.push({
  'event': 'removeFromCart',
  'ecommerce': {
    'currencyCode': 'EUR',
    'remove': {
      'actionField': {
      'list': 'listName',
    },
    'products': [ {
      'id': '2417',
      'name': 'Anti-Malware+%5b2+Years%5d',
      'price': '53.95',
      'brand': 'brandValue',
      'category': 'categoryValue',
      'variant': 'variantValue',
      'quantity': 1,
      'list': 'listName'       
    }] 
  }
});

addToCart example
This event is triggered when a customer adds a recommended product to the cart. This occurs as soon as the customer clicks the Add button and before the page reloads.

dataLayer.push({
  'event': 'addToCart',
  'ecommerce': {
    'currencyCode': 'EUR',
    'add': {
      'actionField': {
        'list': 'listName',
      },
      'products': [ {
        'id': '2417',
        'name': 'Anti-Malware+%5b2+Years%5d',
        'price': '53.95',
        'brand': 'brandValue',
        'category': 'categoryValue',
        'variant': 'variantValue',
        'quantity': 1,
        'list': 'listName'       
      }]
    }
  }
});

submitOrder example
This event is triggered when the customer clicks the Buy Now button. It occurs as soon as the customer clicks the button and before the page reloads.

dataLayer.push({
  'event': 'submitOrder',
  'paymentMethod' : 'CCA_VIS'
});

๐Ÿ“˜

Note

The fact that this event is triggered does not automatically mean that the customer order has been accepted. It is possible that the customer must first correct some validation errors before submitting again.

purchase example
This event is triggered when an order is submitted successfully, with or without payment, and the customer reaches the confirmation page.

dataLayer.push({
  'event' : 'purchase',
  'ecommerce': {
    'currencyCode': 'EUR',
    'purchase': {
      'actionField': {
      'id': '171513018',
      'affiliation': 'cleverbridge',
      'revenue': '53.95',
      'tax':'8.61',
      'shipping': '0',
      'coupon': ''
    },
      'products': [{
        'id': '2417',
        'name': 'Anti-Malware+%5b2+Years%5d',
        'price': '53.95',
        'brand': 'brandValue',
        'category': 'categoryValue',
        'variant': 'variantValue',
        'quantity': 1,
        'list': 'listName' 
      }] 
    }
  }
});

๐Ÿ“˜

Note

To determine if the order was paid or unpaid, you can use the dataLayer value for the paymentStatus field, which can contain the following values:

  • paid -> the order was successfully paid

  • waiting for payment -> the customer chose an offline payment method (e.g. wire transfer) and is expected to wire the money soon

  • quote -> the customer generated a price quote request that can be turned into a paid order later

  • test purchase -> this was a test order using one of the Cleverbridge test credit cards
    You can also gain additional insights by analyzing the dataLayer field cleverbridgePage. This can contain the following values on the confirmation page:

  • confirmation.reject -> the payment was rejected

  • confirmation.pending -> instant processing was not possible and the transaction is scheduled for processing as soon as possible

  • confirmation.successOfflinePayment -> same as paymentStatus = waiting for payment

  • confirmation.successInstantDelivery -> same as paymentStatus = paid
    If the first payment attempt failed or was not processed instantly, Cleverbridge offers the customer a chance to choose a different payment option and try again. In this case, the dataLayer field cleverbridgePage can contain the following status:

  • confirmationpp.reject -> the second payment attempt was rejected

  • confirmationpp.pending -> the transaction is scheduled for processing as soon as possible

  • confirmationpp.successInstantDelivery -> the second payment attempt was successful

  • confirmationpp.successOfflinePayment -> the second payment will be completed offline (e.g. wire transfer)

How to Trigger GTM tags with Events

To only trigger a tag when a certain e-commerce event occurs, create a new GTM trigger with the type Custom Event. Under Event Name, add one of the events listed above. For more information, see Custom event trigger.

Example
The following is an example of a GTM trigger that only activates when a customer places a purchase.

If you have specific questions related to the Cleverbridge Google Tag Manager implementation, or if you want to implement a certain use case, contact our Tracking team at [email protected].