Search documentation...

K

Vitally

Setup

You will need to provide the Analytics API Token and REST API Token.

Once logged into your Vitally account, click the wheel icon in the sidebar (should be the second icon to the right of the house icon).

The sidebar should update. Under Data Management, select the Integrations option.

To generate the Analytics API Token:

  • Once on the Integration screen, select the Vitally Analytics API card.
  • Toggle on the integration, and select the Integrate via HTTPS API tab. Copy the API KEY.

To generate the REST API Token:

  • Once on the Integration screen, select the Vitally REST API card.
  • Toggle on the integration, and click to generate the API Key. Copy the Basic Auth Header once it's generated.

Supported types

Hightouch supports syncing to the following Vitally types:

  • Events
  • Objects

Syncing events

Hightouch supports syncing to a product event.

To ensure syncs send each event, use a hash function for the event model's primary key . The hash should combine all columns, including member ID, timestamp, etc. See the event sync documentation for more information.

Event configuration

Hightouch allows you to choose the event name and timestamp for an event.

Field mapping

Hightouch allows you to pass data to the event properties.

Syncing objects

Hightouch supports syncing to the following Vitally objects:

  • Accounts
  • Organizations
  • Users

Sync modes

Hightouch supports a combination of Insert, Update, and Upsert sync modes based on the Vitally object.

  • For Accounts, we support Insert, Update, and Upsert sync modes.
  • For Organizations, we support Insert, Update, and Upsert sync modes.
  • For Users, we support Insert, Update, and Upsert sync modes.

In the Insert mode, new rows will be inserted into Vitally.

In the Update mode, attributes will be kept up-to-date within Vitally.

In the Upsert mode, new rows will be inserted into Vitally and attributes will be kept up-to-date within Vitally.

Record matching

Based on your Vitally object, database records can be matched from your source to your Vitally workspace by a unique property.

  • Accounts can be matched by external ID or ID.
  • Organizations can be matched by external ID or ID.
  • Users can be matched by email, external ID, or ID.

Field mapping

You can sync columns from your source to Vitally's default and custom fields.

Delete mode

For Accounts, Organizations and Users, you can choose what Hightouch's behavior is when a record leaves the query result set.

The default is to do nothing, but you can also set Hightouch to delete the record.

Ready to get started?

Jump right in or a book a demo. Your first destination is always free.

Book a demoSign upBook a demo

Need help?

Our team is relentlessly focused on your success. Don't hesitate to reach out!

Feature requests?

We'd love to hear your suggestions for integrations and other features.

On this page

SetupSupported typesSyncing eventsEvent configurationField mappingSyncing objectsSync modesRecord matchingField mappingDelete mode

Was this page helpful?