ClientSuccess Destination
ClientSuccess quick info
ClientSuccess accepts Track, Page, Identify, Group, and Alias calls. If you reference it in the Integrations object, call it “ClientSuccess”.
ClientSuccess accepts cloud-mode data from all Segment source types. It does not offer device-mode connections.
This destination is maintained by ClientSuccess.
Getting Started (for CSMs)
If your engineers have already set up Segment, adding Segment data to ClientSuccess is straightforward. All you need to do is turn on the destination.
To turn on the destination, do the following:
- Go to the Segment destinations catalog and enable ClientSuccess.
- Add your
ClientSuccess Source Id
andClientSuccess API Key
(these can be found within ClientSuccess under the top right menu, Apps & Integrations > Usage).
Note: Because ClientSuccess focuses on group level events, you must pass group information before your events will show up. If you turn on the ClientSuccess destination in Segment and don’t see events in ClientSuccess after 24 hours, it may be that your engineers need to send group information to Segment using Segment’s group
call.
Getting Started (for Developers)
ClientSuccess supports the identify
, group
, track
, and page
methods of Segment.
The group
method is required for any data to stick in ClientSuccess. Any track
and page
events fired before the group
method is called for a particular user, will be lost.
Identify
When you identify
a user, Segment will pass that user’s information to ClientSuccess with userId
as an external user Id for ClientSuccess usage. ClientSuccess uses the following of Segment’s standard user profile fields (in parentheses):
firstName
(first_name
)lastName
(last_name
)
All other traits will be sent to ClientSuccess as custom attributes and may be ignored.
Track
When you track
an event, Segment will send that event to ClientSuccess as a custom event.
Page
When you track a page
event, Segment will send that event to ClientSuccess as a custom event.
Group
When you call group
, Segment will send that group’s information to ClientSuccess with groupId
as the id and name
as the group name. Both groupId
and name
are required for ClientSuccess.
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.
Supported Sources and Connection Modes
Before you start, make sure ClientSuccess 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 | ✅ | ✅ | ✅ |
Segment offers an optional Device-based Connection Mode for Mobile data going to ClientSuccess, so that you can use ClientSuccess features that collect data directly from the mobile device. To do this, you must package the Segment-ClientSuccess mobile SDK with the Segment mobile library.
Settings
Segment lets you change these destination settings from the Segment app without having to touch any code.
API Key
You can find your API key in ClientSuccess under the top right menu, Apps & Integrations > Usage
Project Id
You can find your Project Id in ClientSuccess under the top right menu, Apps & Integrations > Usage
This page was last modified: 20 Oct 2020
Need support?
Questions? Problems? Need more info? Contact us, and we can help!