ClientSuccess Destination
This destination is maintained by ClientSuccess.
Getting Started (for CSMs)
If your engineers have already setup 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 toggle on 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 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.
Supported Sources and Connection Modes
The first step is to make sure ClientSuccess 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.
Web | Mobile | Server | |
---|---|---|---|
📱 Device-mode | |||
☁️ Cloud-mode | ✅ | ✅ |
To learn more about about Connection Modes and what dictates which we support, see here.
This destination requires a Device-based Connection Mode for Mobile data. Follow the steps above to ensure you have packaged the ClientSuccess SDK with Segment’s.
Settings
Segment lets you change these destination settings from your Segment dashboard without having to touch any code.
Project Id
You can find your Project Id in ClientSuccess under the top right menu, Apps & Integrations > Usage
API Key
You can find your API key in ClientSuccess under the top right menu, Apps & Integrations > Usage
Need support?
Questions? Problems? Need more info? Contact us, and we can help!