Working with Connections
Creating a Connection
You'll typically create a new connection from the Plugins page. Follow these steps to create a connection:
- From the Space Console, click Plugins. This will bring you to the Connections tab.
- Click New Connection.
- From the New Connection modal, click HTTP.
At the moment, Integrator only supports HTTP connections. Other connection methods are currently in development.
- Fill out the connection as described in the HTTP Connections section below.
- When finished, click Create Connection.
You can also create connections on the fly in the Form Builder and the Workflow Builder.
HTTP Connections
Integrator currently supports only HTTP connections. Other connection types are currently in development.
When creating an HTTP connection, you can specify the following information:
-
Connection Name: Required. A friendly name for the connection.
-
API Documentation Link: The address of any additional documentation explaining the purpose or functions of the API endpoint.
-
Description: A description of the connection.
-
Base URL: Required. The base location of the API endpoint.
-
Set Trusted CA Certificate: Indicates whether the connection requires a trusted custom authority. This only applies to HTTPS connections.
-
Authentication: The method used to authenticate with the connection. Depending on the authentication method selected, additional options will be displayed.
Authorization Type Field Name Required? Basic Auth Username Yes Basic Auth Password No Bearer Token Token Header Yes Bearer Token Token Prefix Yes Bearer Token Token Type Yes Bearer Token Token Yes OAuth 2.0 Access Token URL Yes OAuth 2.0 Client ID Yes OAuth 2.0 Client Secret No OAuth 2.0 Client Auth Yes OAuth 2.0 Scope No OAuth 2.0 Trusted CA Certificate No
Editing a Connection
Once a connection has been created, it can only be modified from the Plugins > Connections window. Follow these steps to edit a connection:
- Click the connection you want to edit.
- From the Actions menu, select Edit.
- Make the necessary changes.
- Click Update Connection.
Updated 18 days ago