Skip to main content

Veeva Vault

Veeva Vault is an enterprise cloud content management and compliance platform built for the life sciences industry. It unifies documents, data, and processes across clinical, regulatory, quality, safety, and commercial operations, managing the full document lifecycle with version control, audit trails, and e-signatures. Using Vault Query Language (VQL), teams query documents, binders, and objects with SQL-like syntax.

Veeva Vault icon

Power end-to-end data operations for your Veeva Vault API with Nexla. Our bi-directional Veeva Vault connector is purpose-built for Veeva Vault, 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 Veeva Vault or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Veeva Vault 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

Prerequisites

Nexla connects to Veeva Vault using your Vault username (email address), password, and Vault DNS. Before creating a credential in Nexla, ensure you have the following:

Veeva Vault Account with API Access

Nexla authenticates to the Veeva Vault API using standard Vault username and password credentials. The Vault user account used for the integration must have sufficient permissions to access the documents, objects, binders, or other Vault resources that will be included in your data flows.

  • The account must be an active Vault user in the relevant Vault instance.
  • For data source operations, the user should have at least read access to the documents, objects, or binders you plan to retrieve.
  • For destination operations, the user must have the appropriate write, create, or update permissions on the target Vault objects or document types.
  • API access is available to all standard Vault users by default — no additional developer role or API subscription is required for most Vault configurations.

For information about managing user roles and permissions in Veeva Vault, refer to the Veeva Vault Help documentation.

Your Vault DNS

The Vault DNS is the subdomain of your Veeva Vault instance URL. For example, if your Vault URL is https://mycompany.veevavault.com, then your Vault DNS is mycompany.veevavault.com.

To find your Vault DNS:

  1. Log in to your Veeva Vault instance in a web browser.

  2. Look at the URL in your browser's address bar. The Vault DNS is the portion of the URL between https:// and the first / — for example, in https://veepharm.veevavault.com/ui/#/, the Vault DNS is veepharm.veevavault.com.

  3. Alternatively, navigate to Admin > Settings > General Settings in your Vault to view the Vault URL and domain information.

Enter the Vault DNS as a fully qualified domain name including the .veevavault.com suffix — for example, mycompany.veevavault.com. Do not include https:// or a trailing slash.

Authenticate

Credentials required

Authenticates via Veeva username and password to obtain a session token, then passes it as a Bearer Authorization header.

FieldRequiredSecretDescription
UsernameYesNoYour Veeva Vault username (email address).
PasswordYesYesYour Veeva Vault password.
Vault DNSYesNoFully qualified domain of your Veeva Vault instance (e.g., example.veevavault.com).

Create a credential in Nexla

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

  2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Nexla authenticates to Veeva Vault by submitting your username and password to the Vault authentication endpoint, obtaining a session token, and then using that token as a Bearer Authorization header for all subsequent API calls. This is the standard Vault API authentication method as described in the Veeva Vault API documentation.

  3. Enter your Veeva Vault username (email address) in the Username field. This is the email address you use to log in to your Vault instance.

  4. Enter your Veeva Vault password in the Password field. This is the same password you use to log in to your Vault instance.

    Important

    Store your Vault credentials securely. Avoid sharing credentials between integrations. Consider creating a dedicated Vault service account for Nexla with only the permissions needed for your integration.

  5. Enter the fully qualified domain name of your Veeva Vault instance in the Vault DNS field — for example, mycompany.veevavault.com. This value is used to construct all API endpoint URLs for this credential.

    The Vault DNS field accepts the domain without a protocol prefix or trailing slash. Nexla will prepend https:// automatically when making API calls. If you have multiple Vault instances (for example, a production vault and a validation vault), create a separate credential for each instance using the corresponding DNS.

  6. 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.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Veeva Vault connector tile, then select the credential that will be used to connect to the Veeva Vault instance, and click Next; or, create a new Veeva Vault credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Veeva Vault API endpoints. Each template is designed specifically for the corresponding Veeva Vault endpoint, making data source setup easy and efficient. 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.

Retrieve Delegations

Retrieves a list of Vault delegations available to the currently authenticated user. A vault delegation grants a user access to another Vault instance, allowing them to work across multiple vaults. Use this endpoint to enumerate which vaults are accessible via delegation for the current user.

  • This endpoint requires no additional required parameters beyond selecting it. The API automatically returns all delegations available to the authenticated user.
  • Optionally, enter an API version string in the API Version field to target a specific Vault API version (e.g., v25.3). The default value is v25.3. Update this value if your Vault instance requires a different API version.

For complete information about vault delegation and the delegations API, refer to the Veeva Vault API Reference.

Retrieve API Versions

Retrieves a list of all API versions currently available for the connected Vault instance. This endpoint is useful for discovering which API versions are supported by your Vault, which is helpful when planning upgrades or ensuring compatibility with a specific version.

  • This endpoint requires no parameters. It calls the top-level /api/ endpoint, which returns a list of all supported API versions without requiring authentication parameters.
  • No additional configuration is needed — select this endpoint and click Test to retrieve the version list.

Submitting a Query

Submits a Vault Query Language (VQL) statement to retrieve data from your Vault. VQL uses a SQL-like syntax and can query documents, binders, vault objects, and their associated fields. This is the most flexible endpoint for retrieving structured data from Veeva Vault, supporting filters, joins, ordering, and pagination automatically via next-page links.

  • Enter your VQL statement in the VQL Query field. This field is required. A VQL statement follows the pattern:

    • SELECT field1, field2 FROM object_name WHERE condition
    • Example for documents: SELECT id, name__v, status__v FROM documents WHERE type__v = 'Clinical'
    • Example for a vault object: SELECT id, name__v FROM product__v
    • Use SELECT * to retrieve all fields from the target object or document type.
  • Optionally, update the API Version field if your Vault requires a version other than the default v25.3.
  • This endpoint uses automatic next-page pagination, meaning Nexla will continue fetching subsequent pages until all matching records have been retrieved. No manual pagination configuration is needed.

VQL query strings sent via this endpoint can be up to 50,000 characters. For complex or large result sets, use WHERE clauses to limit the data returned. Full VQL syntax documentation is available at the Veeva Vault Query Language Reference.

List All Documents

Retrieves all documents from the connected Vault using offset-based pagination. This endpoint returns document metadata for every document in the Vault, including document IDs, names, types, statuses, and other standard document fields. Use this endpoint when you need a complete inventory of all documents in the Vault.

  • No required parameters are needed for this endpoint. Nexla automatically handles offset-based pagination, retrieving up to 1,000 records per page and continuing until all documents are retrieved.
  • Optionally, update the API Version field if your Vault requires a version other than the default v25.3.

For very large Vaults, the "Submitting a Query" endpoint using VQL is often more efficient, as it allows you to filter documents by type, status, or other criteria rather than retrieving all documents at once.

Get Document

Retrieves the metadata for a single document by its unique document ID. Use this endpoint when you know the specific document ID and need to retrieve its full metadata record, including all document fields and properties.

  • Enter the numeric document ID in the Document ID field. This field is required. Document IDs can be obtained from the List All Documents endpoint or from VQL queries against the documents object.
  • Optionally, update the API Version field if your Vault requires a version other than the default v25.3.

The response data path for this endpoint is $.data, meaning Nexla will extract the document metadata object directly from the API response.

List Document Versions

Retrieves all versions of a specific document. Veeva Vault maintains a complete version history for each document, with major and minor version numbers. Use this endpoint to enumerate all versions of a document, including their version numbers, statuses, and modification dates.

  • Enter the document ID in the Document ID field. This field is required. The endpoint will return all versions associated with the specified document.
  • Optionally, update the API Version field if your Vault requires a version other than the default v25.3.

Get Document Version

Retrieves the metadata for a specific version of a document, identified by document ID, major version number, and minor version number. In Veeva Vault, each document version is uniquely identified by the combination of these three values. Use this endpoint when you need detailed metadata for a particular version of a document.

  • Enter the document ID in the Document ID field. This field is required.
  • Enter the major version number in the Major Version field. This field is required. In Vault, the major version increments when a document is promoted through a lifecycle state (e.g., from Draft to Approved). For example, enter 1 for version 1.x.
  • Enter the minor version number in the Minor Version field. This field is required. The minor version increments during the drafting process. For example, enter 0 for version 1.0.
  • Optionally, update the API Version field if your Vault requires a version other than the default v25.3.

Download Document File

Downloads the source file (e.g., PDF, Word, Excel) attached to the latest version of a specific document. Use this endpoint when you need to retrieve the actual document file content, rather than just its metadata.

  • Enter the document ID in the Document ID field. This field is required. Nexla will retrieve the file attachment for the most recent version of the specified document.
  • Optionally, update the API Version field if your Vault requires a version other than the default v25.3.

This endpoint downloads the raw file body. The file is streamed and processed by Nexla as a file-type response. Ensure your Nexla flow is configured to handle binary file data appropriately downstream.

Download Document Version File

Downloads the source file for a specific version of a document, identified by document ID, major version, and minor version number. Use this endpoint when you need to retrieve the file content of a historical version rather than the latest version.

  • Enter the document ID in the Document ID field. This field is required.
  • Enter the major version number in the Major Version field. This field is required.
  • Enter the minor version number in the Minor Version field. This field is required.
  • Optionally, update the API Version field if your Vault requires a version other than the default v25.3.

Download Document Version Rendition File

Downloads a rendition file for a specific version of a document. A rendition is a converted or generated representation of a document — for example, a viewable PDF rendition generated from a Word source file, or an imported rendition uploaded separately. Use this endpoint to retrieve rendition files for use in downstream processing or distribution.

  • Enter the document ID in the Document ID field. This field is required.
  • Enter the major version number in the Major Version field. This field is required.
  • Enter the minor version number in the Minor Version field. This field is required.
  • Enter the rendition type in the Rendition Type field. This field is required. Common rendition types in Veeva Vault include:

    • viewable_rendition__v — The viewable PDF rendition generated by Vault for display in the browser viewer
    • imported_rendition__v — A rendition that was manually uploaded or imported
    • Custom rendition types may be configured in your Vault — check your Vault's rendition type configuration for available options
  • Optionally, update the API Version field if your Vault requires a version other than the default v25.3.

Download Document Attachment Version

Downloads a specific version of a file attachment associated with a document. Documents in Veeva Vault can have one or more attachments — supplementary files linked to the document record. Use this endpoint to retrieve a specific version of a document-level attachment.

  • Enter the document ID in the Document ID field. This field is required.
  • Enter the attachment ID in the Attachment ID field. This field is required. Attachment IDs can be retrieved via the Veeva Vault API's document attachments endpoint.
  • Enter the attachment version number in the Attachment Version field. This field is required.
  • Optionally, update the API Version field if your Vault requires a version other than the default v25.3.

Download Document Version Attachment Version

Downloads an attachment file from a specific version of a document. This endpoint provides granular control, allowing you to retrieve a specific version of an attachment that belongs to a specific version of a document. Use this endpoint when working with historical document versions that each have their own attachment sets.

  • Enter the document ID in the Document ID field. This field is required.
  • Enter the major document version number in the Major Version field. This field is required.
  • Enter the minor document version number in the Minor Version field. This field is required.
  • Enter the attachment ID in the Attachment ID field. This field is required.
  • Enter the attachment version number in the Attachment Version field. This field is required.
  • Optionally, update the API Version field if your Vault requires a version other than the default v25.3.

Read Annotations by Document Version and Type

Retrieves annotations for a specific version of a document. Annotations in Veeva Vault include comments, notes, and markup placed on document renditions by reviewers during the review and approval process. Use this endpoint to extract annotation data for auditing, reporting, or downstream processing.

  • Enter the document ID in the Document ID field. This field is required.
  • Enter the major version number in the Major Version field. This field is required.
  • Enter the minor version number in the Minor Version field. This field is required.
  • Optionally, update the API Version field if your Vault requires a version other than the default v25.3.

Annotation data is returned in the $.annotations[*] path of the API response. Each annotation record includes fields for annotation type, content, placement, author, and timestamp.

Retrieve Document Template Metadata

Retrieves metadata for all document templates configured in the Vault. Document templates in Veeva Vault are pre-configured document structures that define required fields, lifecycle states, and classification for specific document types. Use this endpoint to audit available document templates or understand the metadata structure of templates in your Vault.

  • No required parameters are needed for this endpoint. It returns all document template metadata available in the connected Vault.
  • Optionally, update the API Version field if your Vault requires a version other than the default v25.3.

Retrieve Document Template Collection

Retrieves a collection of all document templates available in the Vault, including their names and IDs. Use this endpoint to list available templates for discovery, reporting, or to obtain template IDs needed for document creation operations.

  • No required parameters are needed for this endpoint. It returns the complete list of document templates in the Vault.
  • Optionally, update the API Version field if your Vault requires a version other than the default v25.3.

Retrieve All Binders

Retrieves a collection of all binders from the Vault using offset-based pagination. Binders in Veeva Vault are containers that organize related documents into a hierarchical structure — similar to a folder or dossier. They are commonly used in regulatory submissions (e.g., eCTD), quality management systems, and clinical trial master files. Use this endpoint to retrieve binder metadata for all binders in the Vault.

  • No required parameters are needed for this endpoint. Nexla automatically handles offset-based pagination, retrieving up to 1,000 records per page until all binders are returned.
  • Optionally, update the API Version field if your Vault requires a version other than the default v25.3.

Retrieve Binder

Retrieves a single binder by its unique ID, including the binder's metadata and node structure. Use this endpoint when you need the full details of a specific binder, including its sections, subsections, and the documents linked within it.

  • Enter the binder ID in the Binder ID field. This field is required. Binder IDs can be obtained from the Retrieve All Binders endpoint or from VQL queries against the binders object.
  • Optionally, update the API Version field if your Vault requires a version other than the default v25.3.

Retrieve Binder Template Metadata

Retrieves metadata for binder templates in the Vault. Binder templates define the structure and configuration for creating new binders of a specific type. Use this endpoint to discover available binder templates and understand their configuration.

  • No required parameters are needed for this endpoint.
  • Optionally, update the API Version field if your Vault requires a version other than the default v25.3.

Retrieve Binder Template Node Metadata

Retrieves metadata for binder template nodes. Binder template nodes define the section structure within a binder template — for example, the sections and subsections required in a regulatory submission binder. Use this endpoint to understand the node hierarchy available within binder templates.

  • No required parameters are needed for this endpoint. It returns the complete set of binder template node metadata for the Vault.
  • Optionally, update the API Version field if your Vault requires a version other than the default v25.3.

Retrieve Object Record Attachments

Retrieves the list of file attachments associated with a specific record in a Vault object. Vault objects are structured data entities (similar to database tables) used to manage business data such as products, studies, sites, or custom records. Attachments on object records are files linked to those records. Use this endpoint to retrieve attachment metadata for a given object record.

  • Enter the API name of the Vault object in the Object Name field. This field is required. Vault object API names use the __v suffix convention for standard objects — for example, product__v, study__v, or site__v. Custom objects use the __c suffix.
  • Enter the unique record ID in the Object Record ID field. This field is required. Record IDs can be obtained using VQL queries against the target object.
  • Optionally, update the API Version field if your Vault requires a version other than the default v25.3.

Download Object Record Attachment File

Downloads a specific version of a file attachment associated with an object record. Use this endpoint to retrieve the actual file content of an attachment on a Vault object record.

  • Enter the API name of the Vault object in the Object Name field. This field is required (e.g., product__v).
  • Enter the object record ID in the Object Record ID field. This field is required.
  • Enter the attachment ID in the Attachment ID field. This field is required.
  • Enter the attachment version number in the Attachment Version field. This field is required.
  • Optionally, update the API Version field if your Vault requires a version other than the default v25.3.

Retrieve Object Metadata

Retrieves the metadata schema for a specific Vault object, including its fields, field types, and configuration. Use this endpoint to discover the available fields and their data types for a given Vault object before constructing VQL queries or building destination payloads.

  • Enter the API name of the Vault object in the Object Name field. This field is required. Use the Retrieve Object Collection endpoint or Vault's Admin interface to find valid object API names.
  • Optionally, update the API Version field if your Vault requires a version other than the default v25.3.

Retrieve Object Field Metadata

Retrieves detailed metadata for a specific field within a Vault object. This includes field type, label, required status, picklist values, and other field-level configuration. Use this endpoint to understand the constraints and options for a specific field before writing data to it.

  • Enter the API name of the Vault object in the Object Name field. This field is required.
  • Enter the API name of the field in the Field Name field. This field is required. Field API names follow the same naming convention as object names — standard fields use __v and custom fields use __c.
  • Optionally, update the API Version field if your Vault requires a version other than the default v25.3.

Retrieve Object Collection

Retrieves a list of all available Vault objects and their metadata. This endpoint returns an overview of every object configured in the Vault, including both standard Veeva objects and custom objects specific to your organization. Use this endpoint to discover all available objects before querying or writing data.

  • No required parameters are needed for this endpoint. It returns all object metadata for the connected Vault instance.
  • Optionally, update the API Version field if your Vault requires a version other than the default v25.3.

Retrieve Object Record

Retrieves a single record from a Vault object by its unique record ID. Use this endpoint when you need the complete field data for a specific record in a Vault object, such as a product, study, or custom business object.

  • Enter the API name of the Vault object in the Object Name field. This field is required (e.g., product__v or study__v).
  • Enter the unique record ID in the Record ID field. This field is required. Record IDs can be retrieved using VQL queries against the target object.
  • Optionally, update the API Version field if your Vault requires a version other than the default v25.3.

Retrieve All Users

Retrieves all users in the Vault instance, including their user IDs, names, email addresses, roles, and status. Use this endpoint to audit Vault user accounts, synchronize user data with external systems, or build user-based reporting.

  • No required parameters are needed for this endpoint. Nexla automatically handles offset-based pagination, retrieving up to 1,000 users per page.
  • Optionally, update the API Version field if your Vault requires a version other than the default v25.3.

Validate Session User

Retrieves information about the currently authenticated user — the Vault user whose credentials are being used in the Nexla credential. This endpoint is useful for verifying that authentication is working correctly and confirming which user account and permissions are active for the current session.

  • No required parameters are needed for this endpoint. It returns the profile and access details for the authenticated session user.
  • Optionally, update the API Version field if your Vault requires a version other than the default v25.3.

This endpoint calls /api/{version}/objects/users/me. It is also used internally by Nexla to validate the credential at the time of creation.

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.

Manual configuration

Veeva Vault data sources can also be manually configured to ingest data from any valid Veeva Vault API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Veeva Vault API URLs follow the pattern https://{vault_dns}/api/{version}/{endpoint_path} — for example, https://mycompany.veevavault.com/api/v25.3/objects/documents. 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.

For most Veeva Vault API endpoints, the relevant data is found at paths such as $.data[*], $.users[*], $.objects[*], $.delegations[*], or $.versions[*]. You do not need to add an Authorization header — it is handled automatically by the Veeva Vault credential — but some endpoints (e.g., the Vault Query Language endpoint) accept special headers such as X-VaultAPI-DescribeQuery:true to include field metadata in the response. Refer to the Veeva Vault API Reference for the full list of available endpoints and response structures.

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 Veeva Vault 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.

Use as a destination

Click the + icon on the Nexset that will be sent to the Veeva Vault destination, and select the Send to Destination option from the menu. Select the Veeva Vault connector from the list of available destination connectors, then select the credential that will be used to connect to the Veeva Vault instance, and click Next; or, create a new Veeva Vault credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Veeva Vault write endpoints. Each template is designed specifically for the corresponding Veeva Vault endpoint, making destination setup easy and efficient. 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 Document

Creates a new document in the Vault. The document metadata — such as type, subtype, classification, lifecycle, name, and required fields — must be included in the Nexset data being sent to this destination. Use this endpoint when you need to programmatically create documents in Vault from external systems or data flows.

  • Optionally, enter an API version string in the API Version field to target a specific Vault API version (e.g., v25.3). The default is v25.3.
  • The Nexset data will be sent as a JSON body to the Vault Documents API. Each record in the Nexset should represent a document to be created, with fields matching the required and optional document properties in your Vault (e.g., name__v, type__v, lifecycle__v, title__v).

Newly created documents will be in the Initial state of the configured document lifecycle. Required document fields depend on your Vault's document type configuration. Refer to your Vault Administrator or the Veeva Vault API Reference for the required fields for each document type.

Update Document

Updates the metadata and properties of an existing document in the Vault. Use this endpoint to modify document fields such as title, description, owner, status, or any other editable document attribute. The document itself (i.e., the file content) is not changed — only its metadata is updated.

  • Enter the document ID of the document to update in the Document ID field. This field is required. The document ID is the unique numeric identifier of the target document in Vault.
  • Optionally, update the API Version field if your Vault requires a version other than the default v25.3.
  • The Nexset data should include the document fields to be updated as key-value pairs. Only the fields included in the payload will be updated — fields not included will retain their existing values.

Reclassify Document

Reclassifies a document to a different document type, subtype, or classification. In Veeva Vault, document classification determines the document's available fields, lifecycle, and behavior. Reclassification changes the type-based attributes of the document without creating a new version. Use this endpoint when a document's classification needs to be corrected or updated to align with regulatory or operational requirements.

  • Enter the document ID of the document to reclassify in the Document ID field. This field is required.
  • Optionally, update the API Version field if your Vault requires a version other than the default v25.3.
  • The Nexset data should include the new classification fields. Reclassification typically requires specifying the new type__v, subtype__v, and classification__v values, along with any required fields for the new classification:

    • type__v — The API name of the new document type
    • subtype__v — The API name of the new document subtype (if applicable)
    • classification__v — The API name of the new classification (if applicable)

Reclassification may change required fields and lifecycle assignments. Ensure that all fields required by the new classification are included in the payload. Refer to your Vault Administrator for the correct classification values.

Update Document Version

Updates the metadata of a specific version of a document. Use this endpoint when you need to update fields on a particular historical version of a document rather than the latest version.

  • Enter the document ID in the Document ID field. This field is required.
  • Enter the major version number in the Major Version field. This field is required.
  • Enter the minor version number in the Minor Version field. This field is required.
  • Optionally, update the API Version field if your Vault requires a version other than the default v25.3.
  • The Nexset data should include the document version fields to be updated as key-value pairs.

Create Single Document Version

Creates a new version of an existing document. In Veeva Vault, creating a new document version allows you to add a superseding version while preserving the document's history. Use this endpoint when you need to programmatically create a new draft version of an existing document.

  • Enter the document ID of the document for which a new version will be created in the Document ID field. This field is required.
  • Optionally, update the API Version field if your Vault requires a version other than the default v25.3.
  • The Nexset data should include the metadata and file reference for the new version.

Delete Single Document Attachment

Deletes a document attachment from a specific document. Use this endpoint to remove attachments that are no longer needed. Deletion is permanent — deleted attachments cannot be recovered unless your Vault configuration includes attachment version history.

  • Enter the document ID in the Document ID field. This field is required.
  • Enter the attachment ID in the Attachment ID field. This field is required. The attachment ID uniquely identifies the specific attachment to be deleted.
  • Optionally, update the API Version field if your Vault requires a version other than the default v25.3.

:::warning Important Attachment deletion is permanent. Verify that the correct attachment ID is specified before executing this operation. Consider testing with a non-production Vault instance first. :::

Delete Single Document Attachment Version

Deletes a specific version of a document attachment. Use this endpoint when you need to remove a particular version of an attachment while preserving other versions.

  • Enter the document ID in the Document ID field. This field is required.
  • Enter the attachment ID in the Attachment ID field. This field is required.
  • Enter the attachment version number in the Attachment Version field. This field is required.
  • Optionally, update the API Version field if your Vault requires a version other than the default v25.3.

Create Document Attachment

Creates a new attachment on a document. Attachments are supplementary files linked to a document record, such as supporting evidence, reference materials, or related files. Use this endpoint to programmatically add attachments to existing documents in Vault.

  • Enter the document ID in the Document ID field. This field is required. The attachment will be linked to the specified document.
  • Optionally, update the API Version field if your Vault requires a version other than the default v25.3.
  • The Nexset data should include the file content or reference for the attachment to be created.

Restore Document Attachment Version

Restores a previously deleted version of a document attachment. Use this endpoint when an attachment version was deleted in error and needs to be recovered.

  • Enter the document ID in the Document ID field. This field is required.
  • Enter the attachment ID in the Attachment ID field. This field is required.
  • Enter the attachment version number to restore in the Attachment Version field. This field is required.
  • The Restore Flag field defaults to true and does not need to be changed for standard restore operations.
  • Optionally, update the API Version field if your Vault requires a version other than the default v25.3.

Update Binder

Updates the metadata of an existing binder. Binders in Veeva Vault are containers that organize related documents into a hierarchical structure. Use this endpoint to update binder properties such as name, description, owner, or other configurable metadata fields.

  • Enter the binder ID in the Binder ID field. This field is required. Binder IDs can be obtained from the Retrieve All Binders source endpoint or from VQL queries against the binders object.
  • Optionally, update the API Version field if your Vault requires a version other than the default v25.3.
  • The Nexset data should include the binder fields to be updated as key-value pairs.

Create & Upsert Object Records

Creates new records or updates existing records in a Vault object. This endpoint supports both create and upsert operations. An upsert will update a record if it already exists or create it if it does not, based on a configured external ID field. Use this endpoint to synchronize records from external systems into Vault objects such as products, studies, sites, or custom business objects.

  • Enter the API name of the Vault object in the Object Name field. This field is required. For example, use product__v to create or upsert records in the Product object, or study__v for the Study object. Custom objects use the __c suffix.
  • Optionally, update the API Version field if your Vault requires a version other than the default v25.3.
  • The Nexset data should include the object record fields as key-value pairs. Field API names follow Vault naming conventions — standard fields use the __v suffix (e.g., name__v, status__v) and custom fields use __c.

For upsert operations, include the external ID field and its value in the payload. Your Vault Administrator can confirm which field is configured as the external ID for the target object.

Update Object Records

Updates existing records in a Vault object. Use this endpoint when you need to modify field values on existing object records, such as updating the status, owner, or other editable fields of products, studies, sites, or custom records in Vault.

  • Enter the API name of the Vault object in the Object Name field. This field is required (e.g., product__v, study__v).
  • Optionally, update the API Version field if your Vault requires a version other than the default v25.3.
  • The Nexset data should include the record ID (id) and the fields to be updated for each record. Only fields included in the payload will be modified.

Create Group

Creates a new user group in the Vault instance. Groups in Veeva Vault are used to manage user access and permissions by assigning roles and security profiles to collections of users. Use this endpoint to programmatically create groups as part of user provisioning or access management workflows.

  • Optionally, update the API Version field if your Vault requires a version other than the default v25.3.
  • The Nexset data should include the group properties. Common fields for group creation include:

    • label__v — The display name of the group
    • active__v — Whether the group is active (true or false)
    • allow_delegation_among_members__v — Whether delegation is allowed among group members

Update Group

Updates an existing user group in the Vault instance. Use this endpoint to modify group properties such as the group name, active status, or membership settings.

  • Enter the group ID in the Group ID field. This field is required. The group ID is the unique numeric identifier of the group in Vault.
  • Optionally, update the API Version field if your Vault requires a version other than the default v25.3.
  • The Nexset data should include the group fields to be updated as key-value pairs.

Load Data Objects

Submits a bulk load job to create or update multiple records in Vault objects via a CSV multipart upload. The Vault Loader API is designed for high-volume data operations and is more efficient than individual record API calls when loading large numbers of records. Use this endpoint when you need to bulk-load data into Vault objects as part of a data migration or large-scale integration.

  • Optionally, update the API Version field if your Vault requires a version other than the default v25.3.
  • The Nexset data is sent as a multipart/form-data request. The payload should be structured according to the Vault Loader API specification, which requires a CSV file containing the records to be loaded along with metadata about the target object and operation type.

The Vault Loader API processes jobs asynchronously. After submitting the load job, use the Vault API to check the job status and retrieve results. Refer to the Veeva Vault API Reference for full Loader API documentation.

Manual configuration

Veeva Vault destinations can also be manually configured to send data to any valid Veeva Vault API endpoint. Using manual configuration, you can also configure Nexla to automatically send the response received from the Veeva Vault API after each call to a new Nexla webhook data source. 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.

Veeva Vault API URLs follow the pattern https://{vault_dns}/api/{version}/{endpoint_path}. Most document and object record operations use JSON format; for update operations, include the ID of the resource to be updated at the end of the URL — for example, https://mycompany.veevavault.com/api/v25.3/objects/documents/12345 to update document 12345. The Vault Loader endpoint uses multipart/form-data for CSV-based bulk operations instead. As with data sources, you do not need to add an Authorization header — it is handled automatically by the Veeva Vault credential.

Save & activate

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 the configured Veeva Vault endpoint, open the destination resource menu, and select Activate.

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