Vessel · Controlled Vocabulary
Vessel Embedded Integrations Vocabulary
Domain vocabulary for the Vessel developer-first embedded integrations platform covering CRM, sales engagement, authentication flows, connection management, and integration concepts.
12 Terms
Updated
Vessel Vocabulary is a controlled vocabulary published by Vessel on the APIs.io network, defining 12 terms.
Defined terms include Access Token, Actions API, Connection, Connection Status, and Embedded Integration.
A controlled vocabulary pins the words an API’s schemas, parameters and documentation use to one agreed definition each — the shared language a human or an agent needs to read the API the same way its authors do.
Terms
Access Token
A secret token obtained by exchanging a public token or session token that is used to make API calls on behalf of a user's connected integration. Must be stored securely on the backend and never exposed in the client.
Actions API
Vessel's pre-built, validated interface for interacting with downstream integrations. Actions validate both request inputs and API responses using zod, standardize data types (ISO 8601 dates, string IDs), and abstract downstream provider quirks for a consistent developer experience.
Connection
A user's authenticated link to a specific third-party integration (e.g., their Salesforce org, HubSpot account). Identified by a connectionId. Connections have lifecycle statuses: NEW_CONNECTION, INITIAL_SYNCED, and READY.
Connection Status
The current synchronization state of a CRM connection. NEW_CONNECTION blocks CRM API calls. INITIAL_SYNCED means the first 30 days of data has synced and CRM calls are unblocked. READY means all historical data has synced.
Embedded Integration
A native integration built into a product that allows end-users to connect their own third-party tools. Vessel provides the infrastructure to build embedded integrations without managing authentication, rate limits, or data normalization.
Link Token
A temporary token used to initiate the Vessel Link authentication flow in the CRM API. Retrieved from /link/token and passed to the @vesselapi/react-vessel-link component to open the OAuth modal.
Passthrough API
A Vessel API endpoint that forwards authenticated requests directly to the downstream integration provider. Authentication credentials are automatically attached. Useful for calling provider endpoints not yet covered by Vessel actions.
Public Token
A temporary, non-sensitive token returned from the Vessel Link UI after a user successfully authenticates their integration. Must be immediately exchanged on the backend for an access token.
Session Token
A temporary token generated by the Vessel Platform API that holds authentication session state. Passed to the Vessel client SDK to open the integration authentication modal.
Unified API
Vessel's normalized API layer that provides a single interface for interacting with multiple CRM, sales engagement, chat, marketing automation, and dialer systems. Normalizes data models, field names, date formats, and ID types across providers.
Vessel Link
Vessel's drop-in React UI component (@vesselapi/react-vessel-link) that provides a pre-built OAuth authentication modal for connecting users' third-party integrations. Handles the OAuth flow and returns a public token on success.
GTM
Go-to-Market. In the Vessel context, GTM tools refer to the sales and marketing technology stack including CRM (Salesforce, HubSpot), sales engagement (Outreach, Apollo, Salesloft), chat (Slack, Teams), marketing automation (Mailchimp, Customer.io), and dialers (Aircall, RingCentral).