Typeform
Version
This integration utilizes the Typeform Create and Responses API.
Base URL
The base URL used for all Typeform API endpoints:https://api.typeform.com
Authentication & Authorization
The DataGrail Typeform integration connects using OAuth 2.0.
Scopes
The Typeform integration requires specific scopes that must be granted in order to function for a given capability.
| Scope | Base | Access | Deletion |
|---|---|---|---|
offline | ✅ | ||
accounts:read | ✅ | ||
forms:read | ✅ | ||
responses:read | ✅ | ||
responses:write | ✅ |
Endpoints Utilized
DataGrail uses the following endpoints to authorize and test the connection:
| Method | Endpoint | Purpose | Docs |
|---|---|---|---|
| POST | /oauth/access_token | Get and refresh access token | |
| GET | /oauth/authorize | Request authorization |
Limits
Limits in Typeform are calculated using the leaky
bucket algorithm. All requests that are made after rate limits have been
exceeded are throttled and an HTTP 429 Too Many Requests error is returned.
Requests succeed again after enough requests have emptied out of the bucket.
- DataGrail supports requests throttling to stay within 70-80% of specified service rate limits.
- DataGrail processes API responses with HTTP 429 status to interrupt requests, waiting and retrying (using an exponential backoff strategy).
Capabilities
Access
DataGrail's Typeform integration provides Synchronous Access capabilities for the following supported identifier category: Email.Data Interactions
For Access requests, DataGrail will take the following actions:
- Retrieve a list of IDs for all forms.
- Search form responses by the form ID and configured identifiers.
- Retrieve form details by form ID.
Endpoints Utilized
| Method | Endpoint | Purpose | Docs |
|---|---|---|---|
| GET | /forms | Retrieve a list of IDs for all forms | |
| GET | /forms/form_id | Retrieve a form details by the form ID | |
| GET | /forms/form_id/responses | Search form responses |
Deletion
DataGrail's Typeform integration provides Asynchronous (Whole Record) Deletion capabilities for the following supported identifier category: Email.Data Interactions
For Deletion requests, DataGrail will take the following actions:
- Retrieve a list of IDs for all forms.
- Search form responses by the form ID and configured identifiers.
- Delete detected form responses.
Endpoints Utilized
| Method | Endpoint | Purpose | Docs |
|---|---|---|---|
| GET | /forms | Retrieve a list of IDs for all forms | |
| GET | /forms/form_id/responses | Search form responses | |
| DEL | /forms/form_id/responses | Delete responses |
Disclaimer: The information contained in this message does not constitute as legal advice. We would advise seeking professional counsel before acting on or interpreting any material.