API Documentation
Creating a new connection
Due to a limitation in our docs it has become confusing to figure out how to create a new connection. This guide will help you through the process.
Before you can create a new connection we need a few prerequisites: an API Key and an Organization. For more information on these two items please review our quick start guide here.
The last step of the quick start describes how to create a new connection, the POST body consists of:
vendor
- The Enum of the vendor product you want to connect to.credentials
- The specific credential body for the vendor you are connecting to, this is not required for Oauth based connections.options
- (Optional) Any additional options you want to pass to the connection, each vendor has different options available.
Since creating a connection requires you to have the correct combination of vendor, credentials, and options in the correct combination we have provided examples of each below.