Formstack uses a REST API. The documentation explicitly states that "The Formstack API allows users and 3rd party application to access resources programmatically. This API tries to conform to REST principals."
Request Formats: The API accepts two request data types - HTTP url encoded query parameters and JSON.
Response Formats: It offers two response types - JSON (default) and XML.
Authentication: The API uses OAuth2 access tokens for authentication.
Rate Limits: The API is rate limited to 14,400 calls per access token per day.
When making API calls, include the access token in the HTTP Authorization header:
Authorization: Bearer <access-token>
For GET requests, you can also set the access token as part of the query string:
https://www.formstack.com/api/v2/form.json?oauth_token=abcdefg123456
Be mindful of the rate limits when designing your application to interact with the Formstack API.
Yes, the official Formstack API does have webhooks. Here are the key points about Formstack's webhook functionality:
Formstack supports webhooks as a way to send form submission data to a specified URL when a form submission occurs.
Webhooks can be used in place of or as a supplement to the Formstack API.
Webhooks are configured on a form-by-form basis through the form's Settings tab.
To add a webhook:
Formstack provides several options to customize how data is sent to your webhook URL:
Post without sub-field names - Sends complex fields (like Name or Address) as a simple string instead of separate subfields.
Post using field IDs instead of field names - Uses numeric field IDs as keys instead of field names.
Post with field type - Includes the field type for each field in the submission data.
Post with API-friendly field keys - Uses unique labels for each field as keys.
Formstack offers two security options for webhooks:
Shared Secret - A shared key sent with each request to verify it's coming from Formstack.
HMAC Key - Used to sign the webhook payload so you can verify its authenticity and integrity.
While the search results don't explicitly list the types of events you can subscribe to, it's clear that form submissions trigger webhooks. The primary event appears to be:
In summary, Formstack's API does offer webhook functionality, primarily focused on sending form submission data to specified URLs. The webhooks are highly configurable and include security options to ensure data integrity and authenticity.
Here are the key points about the API rate limits for the Formstack API:
By understanding and working within these rate limits, you can ensure reliable and consistent access to the Formstack API for your applications.
Based on the search results provided, here are the key points about the most recent version of the Formstack API:
The most recent version of the Formstack API appears to be V4 (Version 4) [1].
V4 is the latest update to Formstack's form building engine [1].
It is built with modern technologies like React and TypeScript [1].
While the form builder interface hasn't changed significantly, there are major improvements "under the hood" [1].
The update aims to align with industry standards and allow more flexibility in form interactions and manipulations [1].
It enables Formstack to be more agile with future improvements and feature additions [1].
The Formstack API accepts HTTP url encoded query parameters and JSON request formats [2].
It offers JSON (default) and XML response formats [2].
The API is rate limited to 14,400 calls per access token per day [2].
A list of all API methods (exposed as REST resources) is available in the Formstack API documentation [2].
Custom code written for previous versions may need to be updated to be compatible with V4 [1].
Formstack recommends creating duplicates of existing forms before updating to the latest API version [3].
While Formstack provides API access on all paid accounts, their support team does not assist with troubleshooting custom API setups [4].
In summary, V4 is the most recent version of the Formstack API, offering improved technology and flexibility while maintaining the familiar form builder interface. Developers should be aware of potential compatibility issues when upgrading from previous versions.
To get a developer account for Formstack to create an API integration, you can follow these steps:
Sign up for a Formstack account if you don't already have one. You'll need an account with admin access to create API applications.
Log in to your Formstack account as an admin user.
Click on your name in the top right corner and select "API" from the dropdown menu.
On the API page, click "Create new application".
Fill out the required information for your API application, including:
The application will be created automatically after you fill out the details.
Go back to the API home page by selecting "API" from the panel.
You'll now see your newly created API v2 application listed. Click on its name to view the details.
On the application details page, you'll find the following important information:
Based on the provided information, here is a list of data models you can interact with using the Formstack API, along with what is possible for each:
This list covers the main data models and operations available through the Formstack API, providing a comprehensive overview of the possibilities for interacting with Formstack data programmatically.
