Admins and Account Owners
You can use integrations to connect your OpenForms account with external applications and services. Integrations help you add features like payment gateways, use maps, or manage the data flow between your forms and external databases.
There are two ways to add an integration:
- Configure a ready-made integration from the Connectors library
- Build an integration using data connections or the OpenForms API (developers only)
The Connectors Library
Go to Integrations > Connectors to find various free and paid integrations, including
- Azure AD: A User management system that streamlines your user management using SSO.
- Esri ArcGIS: A Form add-on that connects Esri to collect location data, display Esri data on location field maps, and validate answers against Esri location data.
- Google Analytics: A Form add-on that allows you to use Google Analytics to understand how people access your forms.
- Google Maps: A Form add-on that displays Google Maps and allows respondents to drop pins, search for locations, and allows you to collect location data.
- SharePoint: A Form add-on through which you can export form responses to SharePoint lists, including file uploads and custom documents.
- govDelivery: A Form add-on that captures and imports subscribers into your govDelivery Topic lists.
- Payment gateways: Connect to a payment gateway so you can take payments through your forms. The list of gateways that you can choose from depends on your region; some gateways are only available in ANZ or the US.
Using the Connectors Library
Each connector has unique configuration instructions, but to use the library:
- Go to Integrations > Connectors and select an integration from the list. Integrations that are already connected will be marked with a tick icon.
- Each connector will tell you what you need from the external provider and brief steps to install the connector.
- When you’re ready to connect, select Add to go to the integration configuration screen.
- Enter the relevant integration information or credentials.
- Select Add or Save changes, depending on the connector.
- View, update, or delete your connectors at any time by selecting the integration in the Connectors library and choosing a pre-configured instance.
- If a connection is In use, you can select See all to view the list of forms in which it is used.
Some connectors support multiple configurations. For example, multiple instances of a payment gateway to deal with different currencies, or multiple Esri connections to restrict different boundaries.
Data Connections
Data connections use a standard JSON format to send and receive data between OpenForms and an external application or system. Data connections are complex. We recommend having developer experience before attempting to build an integration based on a data connection.
They are useful for pre-populating form fields, validate respondent answers against a database, or lodging responses in an external application. To get started with data connections, please visit the following:
Web API
The OpenForms API helps you manage data by creating a two-way connection between OpenForms and external data management systems. Like data connections, working with the API can be complex and we recommend having developer experience before attempting it.
You can use the API in various ways, including accessing and archiving responses, updating data systems, generating documents and reports, or updating list elements. Admins can create and manage multiple API keys, and we have the following resources to get you started: