This preview of pull request 1639 is meant for internal use only.

CustomerSuccessBox Destination

CustomerSuccessBox quick info

CustomerSuccessBox is in beta, and accepts Track, Page, Identify, and Group calls. If you reference it in the Integrations object, call it “CustomerSuccessBox”.

CustomerSuccessBox accepts cloud-mode data from all Segment source types. It does not offer device-mode connections.

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, contact the CustomerSuccessBox Support team.

This document is about a destination which is in beta

This means that the CustomerSuccessBox Destination is in active development, and some functionality may change before it becomes generally available.

Getting Started

Before you start, make sure CustomerSuccessBox supports the source type and connection mode you’ve chosen to implement. You can learn more about connection modes here.

Web Mobile Server
📱 Device-mode ⬜️ ⬜️ ⬜️
☁️ Cloud-mode

Adding Destination

  1. From the Segment web app, click Catalog.
  2. Search for “CustomerSuccessBox” in the Catalog, select it, and choose which of your sources to connect the destination 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’re not familiar with the Segment Specs, 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’re not familiar with the Segment Specs, 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’re not familiar with the Segment Specs, 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’re not familiar with the Segment Specs, 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 using Segment Personas to this destination as a user property. To learn more about Personas, contact us for a demo.

For user-property destinations, an identify call is sent to the destination for each user being added and removed. The property name is the snake_cased version of the audience name, with a true/false value to indicate membership. For example, when a user first completes an order in the last 30 days, Personas sends an Identify call with the property order_completed_last_30days: true. When the user no longer satisfies this condition (for example, it’s been more than 30 days since their last order), Personas sets that value to false.

When you first create an audience, Personas sends an Identify call for every user in that audience. Later audience syncs only send updates for users whose membership has changed since the last sync.

Settings

Segment lets you change these destination settings from the Segment app without having to touch any code.

API Key

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

This page was last modified: 20 Oct 2020



Get started with Segment

Segment is the easiest way to integrate your websites & mobile apps data to over 300 analytics and growth tools.
or
Create free account