HTTP Connection
An HTTP Connection establishes secure communication between TrueContext and a third-party system. With an HTTP Connection, you can use Data Sources Data sources, also known as "Lookups", are external sources of data that you upload or connect to TrueContext. You can reference this data in a form to populate answers or answer options. Data sources save typing, reduce errors, and make it easy to provide mobile users with only the relevant, most current data. and Data Destinations
A Data Destination specifies where to send data from a submitted form. You can use Data Destinations to automate data sharing and storage, routing data to a specific service (such as email or cloud storage) in several different formats. to fetch data from and send data to a third-party system. This topic describes how an HTTP Connection works and how to set one up.
Available on the Advanced and Enterprise tiers:
Contents
What is an HTTP Connection?
An HTTP Connection is an integration point that TrueContext uses to communicate securely with third-party systems. With HTTP Connections A Connection is an integration point that's used to link a TrueContext Data Source or Data Destination to an external service to import or export data. Data Destinations and Data Sources that share the same external service can also share the same Connection., you can set up custom integrations for systems not included with our out-of-the-box Data Sources
Data sources, also known as "Lookups", are external sources of data that you upload or connect to TrueContext. You can reference this data in a form to populate answers or answer options. Data sources save typing, reduce errors, and make it easy to provide mobile users with only the relevant, most current data. and Destinations.
How an HTTP Connection works
An HTTP Connection creates a secure connection with third-party APIs. With an HTTP Connection you:
-
Enter the base URL of the third-party API.
-
Authenticate using your third-party application’s authentication method.
Once you establish your HTTP Connection with a third-party system, you can use it with the following Data Sources and Destinations.
Use... | To... |
---|---|
HTTP GET Data Sources |
Fetch data. You can use this data to:
|
HTTP Data Destinations |
Send data from submitted forms as a JSON or XML formatted Document. You can use PUT, POST, and PATCH HTTP methods. |
HTTP File Upload Data Destinations |
|
WebDav Data Destinations | Create, update, or move files in an online collection or network drive that uses WebDAV. |
Authentication options
Anonymous Access
Some third-party systems don’t require authentication. In these cases, you can select the option to use Anonymous Access.
Other systems use authentication tokens that are included in a Webhook URL or that must be included in a header. In these cases, you can select the option to use Anonymous Access. Include the authentication tokens in the Base URL or when you set up your Data Source Data sources, also known as "Lookups", are external sources of data that you upload or connect to TrueContext. You can reference this data in a form to populate answers or answer options. Data sources save typing, reduce errors, and make it easy to provide mobile users with only the relevant, most current data. or Data Destination
A Data Destination specifies where to send data from a submitted form. You can use Data Destinations to automate data sharing and storage, routing data to a specific service (such as email or cloud storage) in several different formats. headers.
Authentication scheme
TrueContext supports most standard authentication methods. Choose the method that your third-party system requires:
Set up an HTTP Connection
Prerequisites
-
You must be an integrations expert who is comfortable working with API endpoints and authentication methods.
-
The system you want to integrate with must allow requests from third-party systems.
-
You must have credentials to authenticate the Connection. Check the third-party system API documentation for the authentication method they support.
Note:Check that the credentials you use have permissions to complete all the actions you need the system to perform.
Steps
-
Go to MANAGE FORMS > Connections > CREATE CONNECTION > HTTP Connection.
-
Enter a unique Name (required) and a Description (optional). If you have multiple HTTP Connections, a detailed description helps you identify each one.
-
Select the FormSpaces that can access the Connection.
-
Under Base Connection URL, enter your third-party system Base URL.
Tip: The Base URL is the part of an API endpoint that all endpoints for a system have in common. You specify the Base URL in the Connection, and then you specify endpoints in Data Sources and Destinations. This way, you can reuse your Connection for multiple integrations with the same system.For example, if your API endpoint is
https://api.thirdparty.com/1.0/data/{dataId}
, then your Base URL ishttps://api.thirdparty.com/
. -
Do you need to authenticate using an Authentication Scheme?
-
If no, select Anonymous Access.
-
If yes, select an Authentication Scheme.
Authentication Scheme Credentials required Basic Enter a Username and Password. Digest Enter a Username and Password. NTLM Enter a Username and Password. Form-Based -
Enter a Username, Password, Login POST Url, Username POST Parameter, and Password POST Parameter.
-
(Optional) Enter a Connection Initialization GET URL.
-
If required, enter any additional POST Parameters.
Bearer Enter a Bearer Token. OAuth 2.0 Note:Before you set up your Connection using OAuth, you must configure an OAuth app in your authorization server. When you do this, specify the following Redirect URI:
https://live.prontoforms.com/security/oauth/connections/httpoauth
Info:We’re now TrueContext.To support existing integrations, some items will continue to use “prontoforms” or “pf” in the domain or code.
For more detailed information about what’s changing, visit https://support.truecontext.com/hc/en-us/articles/19516168513556
Select a Grant Type:
Grant Type Actions Client Credentials -
Enter an Access Token URL, Client ID, and Client Secret.
-
(Optional) Enter a list of Scopes separated by a space.
-
(Optional) Select Add to set up Additional Parameters. Enter a Parameter Name and Parameter Value. You can enter up to ten additional parameters.
-
Select Connect to check that you successfully connected.
Authorization Code -
Enter an Authorization Code URL, Access Token URL, Client ID, and Client Secret.
-
(Optional) Enter a list of Scopes separated by a space.
-
(Optional) Select Add to set up Additional Parameters. Enter a Parameter Name and Parameter Value. You can enter up to ten additional parameters.
-
Select Connect to check that you successfully connected.
Note:If you change any of the OAuth 2.0 values you entered, the system resets your Connection. Select Connect, and then save your changes.
Tip:TrueContext supports OAuth 2.0 Refresh Tokens. The system attempts to refresh the Connection if it expires.
API Key Enter a Header Name and Header Value. These are included with all HTTP requests to authenticate with the third-party system. -
-
-
Select Create to save your Connection.