Guide - My First Connector

The goal of this guide is to give you an introduction on how to get started with the Private Connectors API. After completing this walkthrough, you will have the foundational knowledge required to build new Private Integration Applications in Vanta.



  • Basic understanding of REST APIs, web requests, and JSON formats.
  • Familiarity with Postman, or a similar tool to send HTTP requests and process responses.
  • Admin access to a Vanta Instance with an enabled Developer Console.


First we will look at setting up the Postman environment. Skip this step if a different tool will be used to make API calls to Vanta.

Then we will show how to create a new application that will encapsulate your Integration's behavior and obtain the values form the application details required for the API requests.

Lastly we will explore defining resources for that application, and creating the tests that Vanta should perform on them.


By the end of the My First Connector Guide you will have created your first Application, understood the different components of such application and how they are used to send information via the API.

Additionally, you will have the knowledge on how how to create new resources for your application and how to create custom tests to automate the validation of their properties.


Ready? Let's jump in.