The Vault API

The Vault API allows you to extend the functionality of Vault beyond what’s capable from within the Vault Application itself. Below is a sampling of enhancements you can achieve using the Vault API:

  • Feed another system, application or database with data from Vault.
  • Update Vault data (Documents or Object Records) based on data in another system.
  • Perform cross document operations within Vault, such as:
    • Update the state (status and/or field values) of one or more documents based on the state of other documents (e.g. Expire an Approved Email document or Multichannel Presentation when its associated Promotional Piece expires).
    • Update the state of a Binder based on the state of it’s contained Documents.
    • Synchronize state among documents within a binder.
    • Automatically change the binder status to “Approved” when all of its documents are approved.
    • Automatically change the binder status to “Expired” if any one of its documents is expired.
    • Keep the binder’s Expiration Date in synch with the Expiration Date of the documents in the Binder.
  • Email all users that have open tasks in the system, say once a week, with a listing of open tasks.
  • Automatically execute Workflows or State Changes on documents.

The Problem

The use of the Vault API, however, requires you to build, host, monitor, manage and maintain an infrastructure needed to execute your business logic. Building and maintaining this infrastructure can be a prohibitively costly effort.

Our Solution

We solve this problem by taking on these tasks for you. We have built a secure and performant cloud based framework on which your business logic is hosted and there is no need for you to build or maintain infrastructure. You provide your requirements, we build your business logic and host it in our framework. We work with you to develop your requirements and to determine the best way to achieve your goal. Once we develop and deploy your logic to our test environment we help you to test and verify. Once your module is in production, we monitor your module 24x7 and are prepared to address any issues quickly.

Your module can be executed in a number of ways:

  • From within Vault itself via a Job in the Operational Task Scheduler
  • From within Vault via Custom Actions
  • From another application external to Vault
  • Or from our own built­in Task Scheduler

We help you to determine and implement the best approach for executing your logic based on your specific needs.


As mentioned, our framework executes in a secure and performant cloud based framework which we have designed and built. Our framework runs in a owned PAAS ("Platform as a Service") environment that is hosted and managed within Amazon’s secure data centers and utilizes the Amazon Web Service (AWS) technology ( The App maintains a "thin" profile. It stores no customer data. It merely accesses Vault data in response to customer requests over secure HTTP (HTTPS), processes the data per the customer's requirements, then returns the processed data in the HTTPS response, or moves the data to another location per customer requirement. Requests can be initiated from Vault itself, in which case Vault passes a live Session ID on the requests that the App uses to interact with Vault through the API. If requests are initiated from an application other than Vault, the requestor can pass Vault credentials securely in the HTTPS request body, or, if the customer prefers, encrypted Vault credentials can be maintained securely by the framework itself.