This page is not about our Zapier integration itself, but about it's underlying API.
OpnForm currently does not have a public API except for the endpoints described on this page.

OpnForm Zapier Integration API Documentation

Welcome to the OpnForm Zapier Integration API documentation. This guide provides information on how to interact with the OpnForm API to automate your workflows with Zapier.

Authentication

To authenticate with the OpnForm API, you will need an API key. You can find or create an API key in your OpnForm settings under the "Access Tokens" section.
This key must be included in the header of every request you make to the API.

Header:

Authorization: Bearer YOUR_API_KEY

Base URL:
All URLs referenced in the documentation have the following base: https://api.opnform.com

Endpoints

Validate API Key

GET /external/zapier/validate

This endpoint is used by Zapier to test the validity of the API key.

List Forms

GET /external/zapier/forms

Retrieve a list of forms available in a specific workspace.

Query Parameters:
- workspace_id: The ID of the workspace for which to list forms.

New Submission Trigger

POST /external/zapier/webhook

This endpoint is used to set up a webhook for new form submissions.

Body Parameters:
- hookUrl: The URL provided by Zapier to send the submission data.
- form_id: The ID of the form for which to trigger the webhook.

Unsubscribe Webhook

DELETE /external/zapier/webhook

This endpoint is used to unsubscribe from the webhook.

Body Parameters:
- hookUrl: The URL provided by Zapier to stop sending the submission data.
- form_id: The ID of the form for which to unsubscribe the webhook.

Sample Submission Polling

GET /external/zapier/submissions/recent

Retrieves the most recent submissions for a specified form. This endpoint is used by the "New Submission" trigger in Zapier to provide users with the latest form submissions.

Query Parameters
- form_id: The ID of the form to retrieve submissions for.

Sample Response

[
{
"submission_id": "unique_submission_id",
"form_id": "unique_form_id",
"submitted_at": "timestamp",
"data": {
// Form fields and their values
}
}
// Additional submissions can follow here
]

Sample Request

Here's a sample request to list forms in a workspace:

GET {{process.env.BASE_URL}}/external/zapier/forms?workspace_id=12345

Headers:

Authorization: Bearer YOUR_API_KEY
Accept: application/json

Error Handling

The OpnForm API uses conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error resulting from the provided information, and codes in the 5xx range indicate an error with OpnForm's servers.

Support

If you encounter any issues or have questions regarding the API, please reach out to our support team via the live chat on this page.

Updated on: 13/08/2024