Vitally is a customer success platform built for B2B SaaS companies. It combines customer data, team workflows, and AI-powered insights to help CS teams reduce churn and drive expansion — health scoring, playbook automation, project management, NPS tracking, and conversation management. Its REST API exposes accounts, organizations, users, conversations, notes, projects, tasks, NPS responses, and custom objects.
Power end-to-end data operations for your Vitally.io API with Nexla. Our bi-directional Vitally.io connector is purpose-built for Vitally.io, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Vitally.io or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Vitally.io workflows fast, secure, and fully governed.
Features
Type: API
SourceDestination
Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
Request optimization with intelligent batching, retry, and caching to minimize API calls and costs
Your Vitally subdomain is the prefix used in your Vitally login URL. For example, if you log in at https://acme.vitally.io, then your subdomain is acme.
Log in to your Vitally account.
Note the subdomain portion of your browser URL — this is the value you will enter in the Subdomain field when creating the Nexla credential.
Vitally REST API keys are managed in the Vitally settings under Integrations. Each key can be named independently and may be revoked or regenerated at any time without affecting other keys.
Log in to your Vitally account and click your Account Logo in the top-left corner of the application.
Select Settings from the menu to open the settings panel.
Under the Operations section in the left navigation, select Integrations.
On the Integrations page, locate and click Vitally REST API.
On the REST API settings screen, click the Create New API Key button (or the equivalent button to add a new key in the current UI).
Enter a descriptive name for the key — for example, Nexla Integration — so it can be easily identified later.
Click Save or Create to generate the key.
Copy the Secret Token value immediately, as it may not be shown again in full after leaving the page.
Important
Store the API key in a secure location. Anyone with this key can make authenticated requests to your Vitally workspace. Vitally allows you to regenerate or revoke individual keys from the same settings screen if a key is ever compromised.
The Vitally REST API settings screen supports multiple API keys, each with its own name, copyable secret token, copyable Basic Auth header, and individual regenerate/revoke options. For more information, see the Vitally REST API Overview.
Vitally REST API uses HTTP Basic auth. The API key is the Basic username; password is empty. Get the key from Settings > Integrations > Vitally REST API.
Field
Required
Secret
Description
API Key
Yes
Yes
Vitally REST API key from Settings > Integrations > Vitally REST API. Used as the HTTP Basic auth username.
Subdomain
Yes
No
Your Vitally account subdomain (e.g. 'acme' from acme.vitally.io). Used to build the REST base URL.
After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.
Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.
Vitally authenticates all REST API requests using HTTP Basic Auth. Enter your Vitally REST API key in the API Key field. This value is used as the HTTP Basic Auth username for all requests to the Vitally REST API — the password field is left empty, and Nexla handles the Base64 encoding automatically. It should be kept confidential and treated like a password.
Enter your Vitally account subdomain in the Subdomain field. This is the prefix of your Vitally login URL (e.g., acme from https://acme.vitally.io). The subdomain is used to construct the base URL for all API requests, which takes the form https://{subdomain}.rest.vitally.io.
EU-region Vitally accounts use a different base URL format. If your workspace is hosted in the EU, contact your Vitally account representative to confirm the correct subdomain value to use.
Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.
To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Vitally.io connector tile, then select the credential that will be used to connect to the Vitally.io instance, and click Next; or, create a new Vitally.io credential for use in this flow.
Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Vitally.io endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.
Get All Organizations
Retrieves a paginated list of all organizations in your Vitally account, ordered by last-updated date descending. Use this endpoint to sync your full organization hierarchy or perform bulk analysis across all top-level customer organizations.
Select Get All Organizations from the Endpoint pulldown menu.
Optionally, set the Page Size field to control how many organizations are returned per page. The default is 100, which is also the maximum value supported by the Vitally API.
Optionally, set the Sort By field to control the sort order of results. Available options are updatedAt (default) and createdAt. Using createdAt is recommended for reliable full syncs on workspaces where organization records are frequently updated.
This endpoint automatically paginates through all results. Nexla handles pagination using the next cursor token returned in each response.
Get An Organization
Retrieves a single organization record by its Vitally ID. Use this endpoint when you need detailed data for a specific organization, such as refreshing a single record or looking up organization attributes by ID.
Select Get An Organization from the Endpoint pulldown menu.
Enter the Vitally ID of the organization to retrieve in the Organization ID field. This is the internal Vitally UUID assigned to the organization — not an external system ID.
Organization IDs can be obtained by first running the Get All Organizations endpoint, which returns the Vitally ID for each organization in the id field of each result.
Get An Organization's Accounts
Retrieves a paginated list of all accounts belonging to a specific organization. Use this endpoint to understand the account structure within a parent organization, or to sync accounts for a particular organizational unit.
Select Get An Organization's Accounts from the Endpoint pulldown menu.
Enter the Vitally ID of the organization in the Organization ID field. This is required to scope the results to the correct organization.
Optionally, set the Page Size field. The default and maximum value is 100.
Get All Accounts
Retrieves a paginated list of all accounts in your Vitally workspace, ordered by last-updated date descending. This is the most commonly used starting point for syncing your full customer account list into an external system or data warehouse.
Select Get All Accounts from the Endpoint pulldown menu.
Optionally, set the Page Size field. The default is 100, which is also the maximum value.
Optionally, set the Sort By field to createdAt or updatedAt (default). Using createdAt is recommended when performing full reliable syncs on frequently-updated account data.
The Vitally REST API documentation for accounts is available at REST API: Accounts.
Get An Account
Retrieves a single account record by its Vitally ID. Use this endpoint for targeted lookups of individual account data, such as refreshing a specific account's attributes in a downstream system.
Select Get An Account from the Endpoint pulldown menu.
Enter the Vitally ID of the account to retrieve in the Account ID field.
Get An Account's Health Score Breakdown
Retrieves the health score breakdown for a specific account, including the individual metric scores that contribute to the overall health score. Use this endpoint to analyze health score components, identify at-risk accounts, or feed health data into external reporting systems.
Select Get An Account's Health Score Breakdown from the Endpoint pulldown menu.
Enter the Vitally ID of the account in the Account ID field.
Health scores in Vitally are calculated based on configurable metrics including product usage, NPS responses, support ticket volume, and custom signals. The breakdown returned by this endpoint reflects the current scoring configuration in your workspace.
Get All Users
Retrieves a paginated list of all users across your Vitally workspace, ordered by last-updated date descending. Users in Vitally represent the individual contacts associated with accounts. Use this endpoint to sync your full user/contact list.
Select Get All Users from the Endpoint pulldown menu.
Optionally, set the Page Size field. The default and maximum value is 100.
Optionally, set the Sort By field to createdAt or updatedAt (default).
The Vitally REST API documentation for users is available at REST API: Users.
Get An Account's Users
Retrieves a paginated list of users associated with a specific account. Use this endpoint to understand the user composition of an individual account, such as identifying power users or inactive contacts.
Select Get An Account's Users from the Endpoint pulldown menu.
Enter the Vitally ID of the account in the Account ID field.
Optionally, set the Page Size field. The default and maximum value is 100.
Get An Organization's Users
Retrieves a paginated list of users associated with a specific organization. Use this endpoint to analyze user distribution across all accounts within a parent organization.
Select Get An Organization's Users from the Endpoint pulldown menu.
Enter the Vitally ID of the organization in the Organization ID field.
Optionally, set the Page Size field. The default and maximum value is 100.
Get A User
Retrieves a single user record by their Vitally user ID. Use this endpoint when you need to look up or refresh the data for a specific individual contact.
Select Get A User from the Endpoint pulldown menu.
Enter the Vitally ID of the user in the User ID field.
Search For A User by Email
Searches for a Vitally user by their email address and returns the matching user record. Use this endpoint to look up a user when you have their email address but not their Vitally ID.
Select Search For A User by Email from the Endpoint pulldown menu.
Enter the email address to search for in the Email field. This must be an exact match — partial email addresses are not supported.
Search For A User by External ID
Searches for a Vitally user by their external system ID (the ID used to identify this user in your product or CRM). Use this endpoint to cross-reference Vitally user records with identifiers from other systems.
Select Search For A User by External ID from the Endpoint pulldown menu.
Enter the external system ID in the External ID field. This should match the externalId value stored on the Vitally user record.
Get All Conversations
Retrieves a paginated list of all conversations across your Vitally workspace. Conversations in Vitally are threaded communication records associated with accounts or organizations. Use this endpoint to sync all customer conversations for analysis or archival.
Select Get All Conversations from the Endpoint pulldown menu.
Optionally, set the Page Size field. The default and maximum value is 100.
Get A Conversation
Retrieves a single conversation record by its Vitally ID. Use this endpoint to fetch the full details of a specific conversation thread.
Select Get A Conversation from the Endpoint pulldown menu.
Enter the Vitally ID of the conversation in the Conversation ID field.
Get All Conversations For An Organization
Retrieves a paginated list of all conversations linked to a specific organization. Use this endpoint to pull all communication history associated with a parent organization.
Select Get All Conversations For An Organization from the Endpoint pulldown menu.
Enter the Vitally ID of the organization in the Organization ID field.
Optionally, set the Page Size field. The default and maximum value is 100.
Get All Conversations For An Account
Retrieves a paginated list of all conversations linked to a specific account. Use this endpoint to pull all communication history for a particular customer account.
Select Get All Conversations For An Account from the Endpoint pulldown menu.
Enter the Vitally ID of the account in the Account ID field.
Optionally, set the Page Size field. The default and maximum value is 100.
Get All Notes
Retrieves a paginated list of all notes across your Vitally workspace, ordered by last-updated date descending. Notes are free-form records that CSMs create to document account interactions, observations, and action items. Use this endpoint to sync all notes for reporting or knowledge base purposes.
Select Get All Notes from the Endpoint pulldown menu.
Optionally, set the Page Size field. The default and maximum value is 100.
The Vitally REST API documentation for notes is available at REST API: Notes.
Get A Note
Retrieves a single note by its Vitally ID. Use this endpoint to fetch the full content and metadata for a specific note record.
Select Get A Note from the Endpoint pulldown menu.
Enter the Vitally ID of the note in the Note ID field.
Get An Account's Notes
Retrieves a paginated list of notes linked to a specific account. Use this endpoint to pull all notes written about a particular customer account.
Select Get An Account's Notes from the Endpoint pulldown menu.
Enter the Vitally ID of the account in the Account ID field.
Optionally, set the Page Size field. The default and maximum value is 100.
Get An Organization's Notes
Retrieves a paginated list of notes linked to a specific organization. Use this endpoint to pull all notes associated with a parent organization and its accounts.
Select Get An Organization's Notes from the Endpoint pulldown menu.
Enter the Vitally ID of the organization in the Organization ID field.
Optionally, set the Page Size field. The default and maximum value is 100.
List Note Categories
Retrieves a paginated list of all note categories configured in your Vitally workspace. Note categories are administrator-defined classifications used to organize and filter notes. Use this endpoint to retrieve the available categories for use in reporting or when cross-referencing notes by category.
Select List Note Categories from the Endpoint pulldown menu.
Optionally, set the Page Size field. The default and maximum value is 100.
Get All Projects
Retrieves a paginated list of all projects across your Vitally workspace, ordered by last-updated date descending. Projects in Vitally represent structured customer success engagements with milestones, tasks, and owners. Use this endpoint to sync project status and progress data.
Select Get All Projects from the Endpoint pulldown menu.
Optionally, set the Page Size field. The default and maximum value is 100.
The Vitally REST API documentation for projects is available at REST API: Projects.
Get A Project
Retrieves a single project record by its Vitally ID. Use this endpoint to fetch detailed information about a specific project, including its current status and associated tasks.
Select Get A Project from the Endpoint pulldown menu.
Enter the Vitally ID of the project in the Project ID field.
Get An Organization's Projects
Retrieves a paginated list of projects linked to a specific organization. Use this endpoint to pull all ongoing and completed projects for a parent organization.
Select Get An Organization's Projects from the Endpoint pulldown menu.
Enter the Vitally ID of the organization in the Organization ID field.
Optionally, set the Page Size field. The default and maximum value is 100.
Optionally, set the Sort By field to createdAt or updatedAt (default).
Get An Account's Projects
Retrieves a paginated list of projects linked to a specific account. Use this endpoint to pull all projects associated with a particular customer account for status reporting or downstream automation.
Select Get An Account's Projects from the Endpoint pulldown menu.
Enter the Vitally ID of the account in the Account ID field.
Optionally, set the Page Size field. The default and maximum value is 100.
Get All Tasks
Retrieves a paginated list of all tasks across your Vitally workspace, ordered by last-updated date descending. Tasks are action items assigned to CSMs and can be associated with accounts, organizations, or projects. Use this endpoint to sync task data for reporting on CSM workload and follow-through.
Select Get All Tasks from the Endpoint pulldown menu.
Optionally, set the Page Size field. The default and maximum value is 100.
The Vitally REST API documentation for tasks is available at REST API: Tasks.
Get An Organization's Tasks
Retrieves a paginated list of tasks linked to a specific organization. Use this endpoint to pull all open and completed tasks associated with accounts under a particular organization.
Select Get An Organization's Tasks from the Endpoint pulldown menu.
Enter the Vitally ID of the organization in the Organization ID field.
Optionally, set the Page Size field. The default and maximum value is 100.
Get An Account's Tasks
Retrieves a paginated list of tasks linked to a specific account. Use this endpoint to pull all tasks associated with a particular customer account.
Select Get An Account's Tasks from the Endpoint pulldown menu.
Enter the Vitally ID of the account in the Account ID field.
Optionally, set the Page Size field. The default and maximum value is 100.
Get All NPS Responses
Retrieves a paginated list of all Net Promoter Score (NPS) responses across your Vitally workspace. NPS responses capture customer sentiment scores and optional comments collected through Vitally's NPS survey campaigns. Use this endpoint to analyze customer satisfaction trends over time or feed NPS data into a reporting dashboard.
Select Get All NPS Responses from the Endpoint pulldown menu.
Optionally, set the Page Size field. The default and maximum value is 100.
The Vitally REST API documentation for NPS responses is available at REST API: NPS Responses.
Get An Account's NPS Responses
Retrieves a paginated list of NPS responses linked to a specific account. Use this endpoint to analyze customer satisfaction at the account level.
Select Get An Account's NPS Responses from the Endpoint pulldown menu.
Enter the Vitally ID of the account in the Account ID field.
Optionally, set the Page Size field. The default and maximum value is 100.
Get An Organization's NPS Responses
Retrieves a paginated list of NPS responses linked to a specific organization. Use this endpoint to analyze satisfaction scores rolled up at the organization level.
Select Get An Organization's NPS Responses from the Endpoint pulldown menu.
Enter the Vitally ID of the organization in the Organization ID field.
Optionally, set the Page Size field. The default and maximum value is 100.
List Meetings
Retrieves a paginated list of all meeting records across your Vitally workspace, ordered by last-updated date descending. Meetings in Vitally are structured records that can include notes, action items, and transcripts from customer calls. Use this endpoint to sync meeting activity data for reporting or CRM integration.
Select List Meetings from the Endpoint pulldown menu.
Optionally, set the Page Size field. The default and maximum value is 100.
Get A Meeting
Retrieves a single meeting record by its Vitally ID. Use this endpoint to fetch the full details of a specific meeting, including its associated account, attendees, and any recorded notes.
Select Get A Meeting from the Endpoint pulldown menu.
Enter the Vitally ID of the meeting in the Meeting ID field.
List Meetings for an Account
Retrieves a paginated list of meetings associated with a specific account. Use this endpoint to audit customer touchpoint history for an individual account.
Select List Meetings for an Account from the Endpoint pulldown menu.
Enter the Vitally ID of the account in the Account ID field.
Optionally, set the Page Size field. The default and maximum value is 100.
List Meetings for an Organization
Retrieves a paginated list of meetings associated with a specific organization. Use this endpoint to review all customer engagements at the organization level.
Select List Meetings for an Organization from the Endpoint pulldown menu.
Enter the Vitally ID of the organization in the Organization ID field.
Optionally, set the Page Size field. The default and maximum value is 100.
Get A Meeting's Transcript
Retrieves the transcript for a specific meeting by its Vitally meeting ID. Vitally's AI Meeting Recorder can automatically join, transcribe, and summarize customer calls. Use this endpoint to extract transcript content for analysis, archival, or integration with other tools.
Select Get A Meeting's Transcript from the Endpoint pulldown menu.
Enter the Vitally ID of the meeting in the Meeting ID field.
A transcript will only be available for meetings where Vitally's AI Meeting Recorder was active. Meetings without a recorded transcript will return an empty or null response.
List Transcripts
Retrieves a paginated list of all meeting transcripts available in your Vitally workspace. Use this endpoint to bulk-sync transcript data across all recorded meetings.
Select List Transcripts from the Endpoint pulldown menu.
Optionally, set the Page Size field. The default and maximum value is 100.
Get Custom Fields
Retrieves all custom field definitions for a given model type (e.g., account, user, organization). Custom fields are administrator-defined properties added to Vitally objects beyond the standard set. Use this endpoint to discover available custom fields before building transformations that reference them.
Select Get Custom Fields from the Endpoint pulldown menu.
Optionally, enter a model type in the Model field to filter custom fields by object type. Supported values include account, user, and organization. Leave this field blank to retrieve all custom fields across all model types.
Get Custom Objects
Retrieves a paginated list of all custom object type definitions configured in your Vitally workspace. Custom objects allow Vitally workspaces to model domain-specific data structures beyond the built-in account, user, and organization objects. Use this endpoint to discover available custom object types and their IDs before fetching instances.
Select Get Custom Objects from the Endpoint pulldown menu.
Optionally, set the Page Size field. The default and maximum value is 100.
List Custom Object Instances
Retrieves a paginated list of instances for a specific custom object type, identified by its custom object ID. Use this endpoint to sync all records of a particular custom object type out of Vitally.
Select List Custom Object Instances from the Endpoint pulldown menu.
Enter the Vitally ID of the custom object type in the Custom Object ID field. This ID can be retrieved using the Get Custom Objects endpoint.
Optionally, set the Page Size field. The default and maximum value is 100.
Search Custom Object Instances
Searches for instances of a specific custom object type. Use this endpoint to perform filtered searches within a custom object type rather than retrieving all instances.
Select Search Custom Object Instances from the Endpoint pulldown menu.
Enter the Vitally ID of the custom object type in the Custom Object ID field. This is required to scope the search to the correct object type.
Search Admins by Email
Searches for a Vitally admin user by their email address and returns the matching admin record. Admin users are the Vitally team members (CSMs, managers, etc.) who use the Vitally platform. Use this endpoint to look up an admin's Vitally ID when you only have their email address.
Select Search Admins by Email from the Endpoint pulldown menu.
Enter the email address of the admin to search for in the Email field. This must be an exact match.
Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.
Vitally.io data sources can also be manually configured to ingest data from any valid Vitally REST API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.
Vitally REST API URLs follow the pattern https://{subdomain}.rest.vitally.io/resources/{resource}, where {subdomain} is your Vitally account subdomain and {resource} is the resource path (for example, accounts, users, or organizations). Requests to api.vitally.io return 404 errors — always use the rest.vitally.io domain. Most Vitally list endpoints return records under a top-level results key, so the default Path to Data is $.results[*]; for single-record endpoints, use $ to treat the entire response as one record. The next pagination cursor token appears at the top level of paginated responses, separate from the results array. You do not need to include the Authorization header — it is handled automatically by Nexla based on your Vitally.io credential configuration.
Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Vitally.io data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.
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. 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.
Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Vitally.io endpoints. 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.
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.
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.
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.
Vitally.io destinations can also be manually configured to send data to any valid Vitally REST API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.
Vitally write endpoints use POST to create new records, PUT to update existing records by Vitally ID, and DELETE to remove records; the Vitally REST API accepts JSON, so select JSON as the content format. 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 at the end of the URL (for example, https://{subdomain}.rest.vitally.io/resources/accounts/{accountId}). You do not need to include the Authorization header — it is handled automatically by Nexla based on your Vitally.io credential configuration. The Vitally REST API has a default rate limit of 1,000 requests per minute per API key (sliding window); use record batching to reduce the number of API calls when sending large volumes of records, and monitor the X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset response headers to track usage.
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 send the data to the configured Vitally.io endpoint, 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.
