APIS AND INTEGRATIONS
XForms Cx APIs & integrations
XForms uses RESTful APIs to communicate between its mobile apps, reporting/admin web app, and its form template designer toolset. This same set of APIs can also be used by other software tools to leverage the power of XForms’ field data capture into other systems.
GENERALIZED USE CASE
Capture in the field, report anywhere
With the XForms APIs, you could use XForms for field data capture, and then extract that data out of the XForms database for insertion into your existing enterprise reporting dashboard software.
BASIC ACTIONS
How to update a reference-list
To update any type of document, such as Form, Template, and Reference-List, follow these steps:
- Authenticate and obtain the Access-Token
- Get the Reference-List ID (if not available)
- Read the reference-list
- Write the updated reference-list
1. Obtain Auth-Token
Before calling any endpoint in the XForms API, you need to obtain an access token. The Access-Token then needs to be sent along with any other requests.
Token
URL: https://api.xformsweb.com/identity/token
Request type: POST
Request body
{
"email": "string",
"password": "string",
"client": "api.client"
}Response body
{
"access_token": "string",
"expires_in": 10800,
"token_type": "Bearer"
}Comments: expires_in is the number of seconds until the token expires. The value of access_token must be preserved and used for subsequent calls.
2. Get the reference-list’s ID
The reference-list can be downloaded using its ID. If the ID is not available, get a list of existing reference-lists with their IDs first.
List of reference-lists
URL: https://api.xformsweb.com/contents/9488501c-c27b-4b14-9890-8cfff3bd3349
Request type: GET
Header: Authorization: Bearer <access-token>
Response body
{
"id": "9488501c-c27b-4b14-9890-8cfff3bd3349",
"name": "Projects",
"items": [
{ "name": "FRCA" },
{ "name": "Kane" },
...
]
}3. Get reference-list by ID
If the reference-list ID is available, the full document can be retrieved by calling the get-by-ID endpoint.
Reference-list by ID
URL: https://api.xformsweb.com/contents/9488501c-c27b-4b14-9890-8cfff3bd3349
Request type: GET
Header: Authorization: Bearer <access-token>
Response body
{
"id": "9488501c-c27b-4b14-9890-8cfff3bd3349",
"name": "Projects",
"items": [
{ "name": "FRCA" },
{ "name": "Kane" },
...
]
}4. Update the reference-list
The updated reference-list can be uploaded to the server by calling the PUT endpoint. Please note that only the “items” part of the reference-list can be updated. Changing the name or ID might break the link of the reference list to the forms.
Reference-list by ID
URL: https://api.xformsweb.com/contents/9488501c-c27b-4b14-9890-8cfff3bd3349
Request type: PUT
Header: Authorization: Bearer <access-token>
Request body
{
"id": "9488501c-c27b-4b14-9890-8cfff3bd3349",
"name": "Projects",
"items": [
{ "name": "FRCA1" },
{ "name": "Bridge" },
...
]
}NO-CODE INTEGRATIONS
Connect XForms to the tools you already use
You can also use most 3rd party integration tools such as Zapier, Make.com, Integrately, etc. to connect XForms to other software like Procore. A couple of example integrations are listed below.
GOOGLE SHEETS
How to integrate table row data from a mobile form into Google Sheets
ONEDRIVE
Upload your field forms and photos to OneDrive, automatically
Need help with an integration?
Tell us what you want to connect and we’ll help you get XForms Cx data where it needs to go.