CustomerSuccessBox Destination

CustomerSuccessBox is Outcome Driven Customer Success software, which helps maximize retention, drive product adoption and grow revenue for your B2B SaaS

This destination is maintained by CustomerSuccessBox. For any issues with the destination, please reach out to their team.

NOTE: The CustomerSuccessBox Destination is currently in beta, which means that they are still actively developing the destination. This doc was last updated on April 10, 2019. If you are interested in joining their beta program or have any feedback to help improve the CustomerSuccessBox Destination and its documentation, please let their team know!

Getting Started

The first step is to make sure CustomerSuccessBox supports the source type and connection mode you’ve chosen to implement. You can learn more about what dictates the connection modes we support here.

WebMobileServer
📱 Device-mode
☁️ Cloud-mode

Adding Destination

  1. From your Segment UI’s Destinations page click on “Add Destination”.
  2. Search for “CustomerSuccessBox” within the Destinations Catalog and confirm the Source you’d like to connect to.
  3. Copy “API key for POST request” from under “Settings (Gear icon) > Developer Console > API Key tab” in your CustomerSuccessBox.
  4. Fill “API key for POST request” as “API Key” for CustomerSuccessBox Destination app in Segment UI

Identify

Send account_id and user_id in traits of an identify call to set and update the traits of a unique user belonging to a unique Account.

To learn more about user traits that are supported (including custom traits), check User traits section from here

If you haven’t had a chance to review our spec, please take a look to understand what the Identify method does. An example call would look like:

analytics.identify('userID123', {
    account_id: '12345678',
    user_id: 'john.doe@company.com'
});

Identify calls will be sent to CustomerSuccessBox as an identify event.

Track

Send account_id and user_id in properties of a track call to attribute the event to a unique user belonging to a unique Account.

You can also pass product_id and module_id in properties of a track call to define a module and product for the event. To learn more, check Understanding Product Usage section here

If you haven’t had a chance to review our spec, please take a look to understand what the Track method does. An example call would look like:

analytics.track('Order Received', {
    cost: "$120.00",
    account_id: '12345678',
    user_id: 'john.doe@company.com'
});

Track calls will be sent to CustomerSuccessBox as a track event.

Group

Send account_id in traits of a group call to set and update the traits of a unique Account.

To learn more about account traits that are supported (including custom traits), check Account traits section from here

If you haven’t had a chance to review our spec, please take a look to understand what the Group method does. An example call would look like:

analytics.group('accountId123', {
    account_id: '12345678',
    name: "ABC Group"
});

Group calls will be sent to CustomerSuccessBox as an accountevent.

Page

Send account_id and user_id in properties of a page call to attribute the pageview to a unique user belonging to a unique Account. .

If you haven’t had a chance to review our spec, please take a look to understand what the Page method does. An example call would look like:

analytics.page('orders', {
title: "My Orders",
...
account_id: '12345678', //CustomerSuccessBox Account identifier
user_id: 'john.doe@company.com' //CustomerSuccessBox User identifier
});

Page calls will be sent to CustomerSuccessBox as an page event.



Personas

You can send computed traits and audiences generated through Segment Personas to this destination as a user property. To learn more about Personas, reach out for a demo.

For user-property destinations, an identify call will be sent to the destination for each user being added and removed. The property name will be the snake_cased version of the audience name you provide with a true/false value. For example, when a user first completes an order in the last 30 days, we will send an identify call with the property order_completed_last_30days: true, and when this user no longer satisfies we will set that value to false.

When the audience is first created an identify call is sent for every user in the audience. Subsequent syncs will only send updates for those users which were added or removed since the last sync.

Settings

Segment lets you change these destination settings via your Segment dashboard without having to touch any code.

API Key

Settings (Gear icon) > Developer Console > API Key > API key for POST request

Adding CustomerSuccessBox to the integrations object

To add CustomerSuccessBox to the integrations JSON object (for example, to filter data from a specific source), use one of the 1 valid names for this integration:
  • CustomerSuccessBox


  • Questions? Need help? Contact us!
    Can we improve this doc?
    Email us: docs-feedback@segment.com!