HTTP Integration Points Overview
Available on the Advanced and Enterprise tiers:
Key Concepts
HTTP integration points connect TrueContext with third-party systems when TrueContext doesn’t have an out-of-the-box integration for your system. Use HTTP integration points to:
-
Retrieve data from your third-party system for use in TrueContext forms.
-
Send data to your third-party system in any format that the system requires. Common formats include JSON and XML.
-
Send files and attachments to your cloud storage.
TrueContext has the following custom integration points:
-
HTTP Connection—Authenticate with your third-party system to establish secure communication between TrueContext and the third party. Once you establish a connection, you can use it to set up 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.. -
HTTP GET 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.—Retrieve data from your third-party system. Use this data to define answer options in a “lookup” question and to push data to other questions based on the answer. -
HTTP Data Destinations—Send submitted data in text-based documents such as JSON or XML. The 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. converts documents into HTTP requests to the third-party system. -
HTTP File Upload Data Destination—Send Word, PDF, and attachment files—like images and annotated documents—to your cloud storage.
Authenticate
Use an HTTP Connection to establish secure communication between the third-party system and TrueContext. Authenticate using the method required by the third-party system.
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. support most standard authentication methods:
-
Basic
-
Digest
-
NTLM
-
Form-Based
-
Bearer Token
-
OAuth 2.0
-
API Key
Info:The topic HTTP Connection describes in more detail how to authenticate with your third-party system.
Fetch Data
Use an HTTP GET Data Source to fetch data from your third-party system. TrueContext supports source data in the following formats:
-
CSV
-
XML
-
JSON
-
Excel (.xls and .xlsx)
When TrueContext successfully fetches the data, the system converts and stores the data in a table format. Then, you can define answer options for “lookup” Dropdown, Multiselect, and Radio Button questions based on the columns in the Data Source. You can also push data to other questions based on the answer to the “lookup” question.
Push Data
Use an HTTP Data Destination to push data to your third-party system.
How to choose an HTTP Data Destination
Choose a Data Destination based on what you want to send to your third-party system.
| Data to send | Destination type |
|---|---|
|
Data from a submission, by means of an HTTP POST, PUT, or PATCH request. Attach a DREL Note:You must format the request body according to your third-party system requirements. Make sure to select the correct content-type when you set up the document. |
HTTP Data Destination |
| Word and PDF output documents that include all submitted data. Send these to your cloud storage. | HTTP File Upload Data Destination |
| Images, annotated documents, and other file attachments uploaded by the field user. Send these to your cloud storage. | HTTP File Upload Data Destination |
Store response outputs
When you set up your Data Destinations, you can choose to store response outputs. The system saves responses received from your third-party system as key-value pairs. You can use DREL to reference this data in subsequent Data Destinations.
Best Practices
When you set up your custom integration, keep the following best practices in mind:
-
Use an HTTP Connection to authenticate. HTTP Connections support most standard authentication methods. Don’t include secure values or credentials as part of Data Source or Data Destination headers.
-
Make sure to set up at least one Problem Contact email address. When there’s an error, TrueContext emails your Problem Contacts.
-
Create a dedicated integration user account in your third-party system. Customize the integration user’s permissions to restrict access to only necessary data. Use this account to establish your HTTP Connection.
A user account with restricted access ensures that TrueContext Data Sources and Destinations can only access specific data.
-
HTTP File Upload Data Destinations can store responses from your third-party system if you send only one document. To store response outputs for multiple documents, you must create separate HTTP File Upload Data Destinations. Link a single document to each Data Destination to store their respective response outputs.
Custom Integrations Cookbook
Get “recipes” for frequently used custom integration procedures.