Snapforms API

If you want to connect Snapforms to an app that is not a supported integration, you can use our Snapforms API to develop your own custom integrations. 

Common uses for Snapforms API integrations:

• Retrieve form response data
• Import or update the field answers for a single form response
• Trigger an action event in a third-party app when a form is submitted (via webhook).

Please refer to our developer documentation for more information about our API.

Note: Updates or changes to our API are published in our Snapforms changelog.

Obtain Snapforms API credentials

1. Go to Form Settings tab > Integrations
2. Tick Snapforms Developers API
3. Click the Generate New Client Credentials button.
4. Make a note of the Client ID and Client Secret shown on-screen. These details will only appear once.

This API connection is now saved and applies to all forms within your account.

Obtain authorisation token

Use the above credentials in this API call to obtain the authoristion token. The access_token received can be used to authenticate all other API calls.

Add a webhook

To add a webhook for your form, call this API route:

POST: /forms/{slug}/responses/hooks

And pass in the following parameters in the body:

active: true
type: 'custom'
url: '[your webhook URL]'
event: 'responses'

Delete a webhook

To delete a webhook, call this API route:

DELETE: /{slug}/responses/hooks/{webhook}