Vitally Destination


On this page


Vitally is a customer success platform for B2B SaaS companies that wraps your unified customer data with powerful analytics, alerts, and workflows to help you build successful customers.

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

NOTE: Vitally is currently in beta, and this doc was last updated on February 7, 2019. This means that there may still be some bugs for us to iron out and we’re excited to hear your thoughts. If you are interested in joining or have any feedback to help us improve the Vitally destination and its documentation, please let us know!

Getting Started

The first step is to make sure Vitally 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

Enabling Vitally as a destination in Segment can be done in one click from your Vitally account. These instructions are also detailed in the Vitally help center.

  1. Navigate to the Segment integration page within your Vitally account. This can be found in your Account Settings in Vitally by navigating to the Product Data integrations list.

  1. In a separate tab/window, make sure you are logged into your Segment account
  2. Configure the Segment integration via the one-click “Enable with Segment” button. Choose the primary source of product usage data in Segment and Segment will automatically create a destination for Vitally:

  1. You’ll now be able to see and manage your Vitally Destination directly from your Segment workspace

  1. That’s it! Once we receive at least 1 event from Segment, you’ll be able to proceed with the setup process and configure how to create accounts from Segment

Identify

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

analytics.identify('userId123', {
  name: 'John Doe',
  email: 'john.doe@yourcustomer.com',
  avatar: 'https://yourdomain.com/avatars/johndoe.png',
  role: 'CEO'
});

Identify calls are used by Vitally to maintain a picture of a single user. The traits you pass to the Identify call will be displayed on the user’s dashboard and can be used for sorting and filtering users within an account and across all of your users.

Passing along the following traits will correspond to what is displayed in Vitally:

  • name is used to set the name of the user in Vitally
  • email sets the user’s email in Vitally
  • avatar is used to display an avatar for the user

Track

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

analytics.track('enabled-slack-integration', {
   channel: '#support'
})

Track calls are used in Vitally to track and analyze your accounts’ engagement with your product. Vitally provides out-of-the box analysis on your events, plus the ability to define your own custom metrics on top of those events, like Success Metrics and Elements.

Group

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

analytics.group("accountId123", {
  name: "Initech",
  industry: "Technology",
  plan: "enterprise",
  mrr: 2000
});

Group calls are used by Vitally to maintain a picture of an account. Any traits you pass to the Group call are added to the account in Vitally and can be used to analyze your customer base as a whole. You can view a customer’s traits on their dashboard, use them for sorting and filtering, configure rules to automate your customer success process, and even create segments of your accounts.

Passing along the following traits will correspond to what is displayed in Vitally:

  • name is used to set the name of the account in Vitally

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 from your Segment dashboard without having to touch any code.

API Key

The keys to the kingdom, generally found under “settings” in the destination’s website.

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