Skip to main content

Vitally.io Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow data flow that sends data to a Vitally.io location.
vitally_api.png

Vitally.io

Create a Vitally.io Destination​

  1. Click the + icon on the Nexset that will be sent to the Vitally.io destination, and select the Send to Destination option from the menu.

  2. Select the Vitally.io connector from the list of available destination connectors. Then, select the credential that will be used to connect to the Vitally.io organization, and click Next; or, create a new Vitally.io credential for use in this flow.

  3. In Nexla, Vitally.io destinations can be created using pre-built endpoint templates, which expedite destination setup for common Vitally.io write operations. Each template is designed specifically for the corresponding Vitally.io endpoint, making destination configuration easy and efficient.
    • To configure this destination using a template, follow the instructions in Configure Using a Template.

    Vitally.io destinations can also be configured manually, allowing you to send data to Vitally.io endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Vitally.io endpoints. Each template is designed specifically for the corresponding Vitally.io endpoint, making destination setup easy and efficient.

  • To configure this destination using a template, select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

    Create An Organization

    Creates a new organization in Vitally. Use this endpoint to programmatically add top-level customer organizations to your Vitally workspace from an external data source such as a CRM or ERP system.

    • Select Create An Organization from the Endpoint pulldown menu.
    • Map the fields in the incoming Nexset to the organization fields expected by the Vitally API. The request body is sent as JSON. Refer to the Vitally REST API documentation for the full list of supported organization fields.

    Organization records in Vitally represent the top-level customer hierarchy. Each organization can contain multiple accounts. Ensure that any required fields (such as externalId or name) are populated in the Nexset before sending data to this endpoint.

    Update An Organization

    Updates an existing organization by its Vitally ID. Use this endpoint to keep organization attributes in Vitally synchronized with an external system of record such as a CRM.

    • Select Update An Organization from the Endpoint pulldown menu.
    • Enter the Vitally ID of the organization to update in the Organization ID field. This value is appended to the API URL to identify the specific record to update. You can supply a fixed ID or map this value from a field in the Nexset.
    • Map the fields to be updated in the request body. Only the fields included in the Nexset record will be sent — unspecified fields retain their existing values in Vitally.

    Create An Account

    Creates a new account in Vitally. Accounts are the primary customer entities in Vitally — they represent individual customer companies or product instances. Use this endpoint to import accounts from a CRM, data warehouse, or other system into Vitally.

    • Select Create An Account from the Endpoint pulldown menu.
    • Map the fields in the incoming Nexset to the account fields expected by the Vitally API. The request body is sent as JSON. Required fields typically include externalId and name. Refer to the Vitally REST API: Accounts documentation for the complete field reference.

    Create A User

    Creates a new user in Vitally. Users represent the individual contacts or product users associated with accounts. Use this endpoint to sync end-user records from your product database or CRM into Vitally to enable per-user health scoring and segmentation.

    • Select Create A User from the Endpoint pulldown menu.
    • Map the fields in the incoming Nexset to the user fields expected by the Vitally API. The request body is sent as JSON. Required fields typically include accountId (the Vitally account to associate this user with) and email. Refer to the Vitally REST API: Users documentation for the complete field reference.

    Update A User

    Updates an existing user by their Vitally ID. Use this endpoint to keep user attributes in Vitally synchronized with an external system, such as updating email addresses, names, or custom traits.

    • Select Update A User from the Endpoint pulldown menu.
    • Enter the Vitally ID of the user to update in the User ID field. You can supply a fixed ID or map this value from a field in the Nexset.
    • Map the fields to be updated in the request body. Only the included fields will be updated.

    Delete A User

    Deletes a user from Vitally by their Vitally user ID. Use this endpoint to remove users who have churned, been deactivated, or should no longer be tracked in Vitally.

    • Select Delete A User from the Endpoint pulldown menu.
    • Enter the Vitally ID of the user to delete in the User ID field. This value identifies the specific user record to be permanently removed.

    :::danger Important User deletion in Vitally is irreversible. Once a user record is deleted, it cannot be recovered. Verify that the correct user IDs are being passed to this endpoint before activating this destination. :::

    Create A Conversation

    Creates a new conversation in Vitally. Use this endpoint to import conversation records from an external system such as a support platform or email tool into Vitally for centralized customer communication tracking.

    • Select Create A Conversation from the Endpoint pulldown menu.
    • Map the fields in the incoming Nexset to the conversation fields expected by the Vitally API. The request body is sent as JSON. Refer to the Vitally REST API documentation for supported fields.

    Create A Message

    Adds a message to an existing conversation in Vitally. Use this endpoint to append new messages to a conversation thread, such as when importing email replies or support responses into an existing Vitally conversation.

    • Select Create A Message from the Endpoint pulldown menu.
    • Enter the Vitally ID of the conversation to post this message into in the Conversation ID field. The conversation must already exist in Vitally.
    • Map the message fields in the incoming Nexset to the message body fields expected by the Vitally API. The request body is sent as JSON.

    Create A Note

    Creates a new note in Vitally. Use this endpoint to programmatically add notes to accounts — for example, importing call summaries, AI-generated meeting recaps, or interaction records from an external tool into Vitally.

    • Select Create A Note from the Endpoint pulldown menu.
    • Map the fields in the incoming Nexset to the note fields expected by the Vitally API. Required fields typically include accountId and body (the note content). Refer to the Vitally REST API: Notes documentation for the full field reference.

    Update A Note

    Updates an existing note by its Vitally ID. Use this endpoint to update note content or metadata after initial creation.

    • Select Update A Note from the Endpoint pulldown menu.
    • Enter the Vitally ID of the note to update in the Note ID field.
    • Map the fields to be updated in the request body. The request body is sent as JSON.

    Create A Project from a Template

    Creates a new project in Vitally from a project template. Vitally project templates allow you to define a reusable project structure (with pre-configured tasks, milestones, and owners) that can be instantiated for specific accounts. Use this endpoint to automatically kick off structured customer success workflows — such as onboarding or renewal projects — based on triggers in an external system.

    • Select Create A Project from a Template from the Endpoint pulldown menu.
    • Map the fields in the incoming Nexset to the project fields expected by the Vitally API. The request body must include templateId (the Vitally ID of the project template to use) and accountId (the account to associate the project with). Refer to the Vitally REST API: Project Templates documentation for the complete field reference.

    Project template IDs can be found in your Vitally workspace settings under the project templates section. Each template has a unique Vitally ID that is required when calling this endpoint.

    Update A Project

    Updates an existing project by its Vitally ID. Use this endpoint to update project attributes such as status, due date, or custom fields from an external system.

    • Select Update A Project from the Endpoint pulldown menu.
    • Enter the Vitally ID of the project to update in the Project ID field.
    • Map the fields to be updated in the request body. The request body is sent as JSON.

    Create A Task

    Creates a new task in Vitally. Use this endpoint to programmatically create action items for CSMs — for example, triggering follow-up tasks based on health score changes, NPS responses, or events in an external system.

    • Select Create A Task from the Endpoint pulldown menu.
    • Map the fields in the incoming Nexset to the task fields expected by the Vitally API. Required fields typically include accountId, title, and dueDate. Refer to the Vitally REST API: Tasks documentation for the complete field reference.

    Update A Task

    Updates an existing task by its Vitally ID. Use this endpoint to update task status, due dates, or other attributes from an external workflow system.

    • Select Update A Task from the Endpoint pulldown menu.
    • Enter the Vitally ID of the task to update in the Task ID field.
    • Map the fields to be updated in the request body. The request body is sent as JSON.

    Create An NPS Response

    Creates a new NPS response in Vitally. Use this endpoint to import NPS survey responses collected via an external survey tool into Vitally for centralized customer sentiment tracking and health scoring.

    • Select Create An NPS Response from the Endpoint pulldown menu.
    • Map the fields in the incoming Nexset to the NPS response fields expected by the Vitally API. Required fields typically include userId (the Vitally user who submitted the response), score (an integer from 0 to 10), and optionally comment. Refer to the Vitally REST API: NPS Responses documentation for the complete field reference.

    Create A Meeting

    Creates a new meeting record in Vitally. Use this endpoint to import meeting records from external calendar, video conferencing, or CRM tools into Vitally to maintain a complete customer engagement history.

    • Select Create A Meeting from the Endpoint pulldown menu.
    • Map the fields in the incoming Nexset to the meeting fields expected by the Vitally API. Required fields typically include accountId and title. The request body is sent as JSON.

    Update A Meeting

    Updates an existing meeting record by its Vitally ID. Use this endpoint to update meeting details such as title, date, or outcome after initial creation.

    • Select Update A Meeting from the Endpoint pulldown menu.
    • Enter the Vitally ID of the meeting to update in the Meeting ID field.
    • Map the fields to be updated in the request body. The request body is sent as JSON.

    Create/Replace A Meeting's Transcript

    Creates or replaces the transcript for a specific meeting. Use this endpoint to attach or update meeting transcripts, for example when processing recordings from an external transcription service and storing the results in Vitally.

    • Select Create/Replace A Meeting's Transcript from the Endpoint pulldown menu.
    • Enter the Vitally ID of the meeting in the Meeting ID field. The transcript will be associated with this meeting record.
    • Map the transcript segment fields in the incoming Nexset to the transcript body fields expected by the Vitally API. The request body is sent as JSON and should contain the transcript segments with speaker labels and timestamps where available.

    Calling this endpoint on a meeting that already has a transcript will replace the existing transcript. Ensure the new transcript data is complete before sending.

    Create A Custom Object Instance

    Creates a new instance of a custom object type in Vitally. Use this endpoint to populate custom object records from an external data source — for example, syncing product feature usage records, contract data, or other domain-specific objects that have been modeled as custom objects in your Vitally workspace.

    • Select Create A Custom Object Instance from the Endpoint pulldown menu.
    • Enter the Vitally ID of the custom object type in the Custom Object ID field. This identifies which custom object type the new instance belongs to. The custom object ID can be retrieved using the Get Custom Objects source endpoint.
    • Map the instance fields in the incoming Nexset to the fields expected by the Vitally API. The request body is sent as JSON.

    Update A Custom Object Instance

    Updates a specific custom object instance, identified by both the custom object type ID and the instance ID. Use this endpoint to keep custom object records in Vitally synchronized with an external system of record.

    • Select Update A Custom Object Instance from the Endpoint pulldown menu.
    • Enter the Vitally ID of the custom object type in the Custom Object ID field.
    • Enter the Vitally ID of the specific instance to update in the Instance ID field.
    • Map the fields to be updated in the request body. The request body is sent as JSON.

    Delete a Custom Object Instance

    Deletes a specific custom object instance, identified by both the custom object type ID and the instance ID. Use this endpoint to remove stale or invalid custom object records from Vitally.

    • Select Delete a Custom Object Instance from the Endpoint pulldown menu.
    • Enter the Vitally ID of the custom object type in the Custom Object ID field.
    • Enter the Vitally ID of the specific instance to delete in the Instance ID field.

    :::danger Important Custom object instance deletion in Vitally is irreversible. Verify that the correct Custom Object ID and Instance ID values are being passed before activating this destination. :::

    Delete Custom Object Instances (Bulk)

    Bulk-deletes instances of a custom object type, identified by the custom object type ID. Use this endpoint to remove multiple custom object instances at once during data cleanup or decommissioning workflows.

    • Select Delete Custom Object Instances from the Endpoint pulldown menu.
    • Enter the Vitally ID of the custom object type in the Custom Object ID field. All instances matching the request body criteria will be deleted.

    :::danger Important Bulk deletion in Vitally is irreversible. This action will permanently remove multiple records. Verify the scope of the delete operation carefully before activating this destination. :::

Configure Manually​

Vitally.io destinations can be manually configured to send data to any valid Vitally REST API endpoint.

Using manual configuration, you can also configure Nexla to automatically send the response received from the Vitally.io API after each call to a new Nexla webhook data source.

API Method​

  1. To manually configure this destination, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Vitally.io API from the Method pulldown menu. The available write methods for Vitally are:

    • POST: For creating new records (accounts, users, notes, tasks, NPS responses, etc.)
    • PUT: For updating existing records by Vitally ID
    • DELETE: For removing records from Vitally

Data Format​

  1. Select the format in which the Nexset data will be sent to the Vitally.io API from the Content Format pulldown menu. Vitally's REST API accepts JSON — select JSON as the content format. Nexla will automatically convert the Nexset data to JSON for each API call.

API Endpoint URL​

  1. Enter the URL of the Vitally.io API endpoint to which you want to send the Nexset data in the URL field. Vitally REST API URLs follow the pattern https://{subdomain}.rest.vitally.io/resources/{resource}. For update or delete operations, include the Vitally ID of the object to be updated or deleted at the end of the URL (e.g., https://{subdomain}.rest.vitally.io/resources/accounts/{accountId}).

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this destination, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2).

    You do not need to include the Authorization header — it is handled automatically by Nexla based on your Vitally.io credential configuration.

Exclude Attributes from the Call​

Optional

  • If any record attributes in the Nexset should be omitted when sending data to this Vitally.io destination, select the attributes from the Exclude Attributes pulldown menu.

  • Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

Record Batching​

Optional

  1. If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching.

  2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to 100.

  3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings.

The Vitally REST API has a default rate limit of 1,000 requests per minute per API key (using a sliding window). When sending large volumes of records, use record batching to reduce the number of API calls and stay within rate limits. Monitor the rate limit headers returned in each API response (X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset) to track usage.

Response Webhook​

Optional

Nexla can automatically send the response received from the Vitally.io API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and any additional information returned after each call.

  • To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

Sample Request Payload​

Sample request payloads containing a portion of the Nexset data that will be sent to the Vitally.io API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

  • Click on a sample request payload to expand it and view the complete payload content.
  • Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

Endpoint Testing (Manual Configuration)​

After all endpoint settings have been configured, Nexla can send a test payload to the Vitally.io API to ensure that the destination is configured correctly.

  1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

  2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

  3. Click the Send Test Data button at the top of a sample payload to send the test payload to the Vitally.io API using the current settings.

Save & Activate the Destination​

  • Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To begin sending data to Vitally.io, open the destination resource menu, and select Activate.

    The Nexset data will not be sent to Vitally.io until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.