Dokumentation

Ansicht

v1.0.0

Zapier API Reference​

The formhive.net Zapier API allows you to integrate your forms with Zapier workflows by registering webhooks that get triggered when form submissions occur. This API uses token-based authentication and provides endpoints for managing webhooks and form access.

Quick Start

  1. Generate an API token in your formhive.net project settings under the Integration section
  2. Use the token in the Authorization header: Bearer YOUR_TOKEN
  3. Register webhooks for your forms to receive submission data

Authentication

All endpoints require a Bearer token in the Authorization header. API tokens are generated through the formhive.net project settings under the Zapier integration section.

Contact​

formhive.net Support

External Documentation​

Find out more about formhive.net

Servers​

https://app.formhive.net/api/v1/zapierformhive.net server

Forms​

Operations related to form access and management

Operations​

GET/forms

Get accessible forms​

GET
/forms

Retrieve a list of forms that your API token has access to

Authorizations​

bearerAuth

API token for Zapier integration

TypeHTTP (bearer)

Responses​

List of accessible forms
application/json
JSON
{
"success": true,
"message": "string",
"forms": [
{
"id": "string",
"form_id": "string",
"name": "string",
"description": "string",
"created_at": "string",
"updated_at": "string"
}
],
"project": {
"id": "string",
"name": "string",
"description": "string"
},
"token_name": "string"
}

Playground​

Authorization

Samples​

cURL
JavaScript
PHP
Python

Webhooks​

Operations for registering and managing webhooks

Operations​

POST/webhooksDELETE/webhooksDELETE/token/webhooks

Register webhooks​

POST
/webhooks

Register webhooks for one or more forms. When a form submission occurs, the webhook URL will receive the form data.

Authorizations​

bearerAuth

API token for Zapier integration

TypeHTTP (bearer)

Request Body​

application/json
JSON
{
"form_ids": [
"string"
],
"webhook_url": "string",
"target_events": [
[
"form_submission"
]
]
}

Responses​

Webhooks registered successfully
application/json
JSON
{
"success": true,
"message": "string",
"registered_webhooks": [
{
"form_id": "string",
"webhook_id": "string",
"webhook_url": "string",
"target_events": [
"string"
],
"is_active": true,
"created_at": "string"
}
],
"errors": [
{
"form_id": "string",
"error": "string"
}
]
}

Playground​

Authorization
Body

Samples​

cURL
JavaScript
PHP
Python

Unregister specific webhooks​

DELETE
/webhooks

Remove specific webhooks from forms

Authorizations​

bearerAuth

API token for Zapier integration

TypeHTTP (bearer)

Request Body​

application/json
JSON
{
"registered_webhooks": [
{
"form_id": "string",
"webhook_id": "string"
}
]
}

Responses​

Webhooks unregistered successfully
application/json
JSON
{
"success": true,
"message": "string"
}

Playground​

Authorization
Body

Samples​

cURL
JavaScript
PHP
Python

Unregister all webhooks​

DELETE
/token/webhooks

Remove all webhooks associated with your API token

Authorizations​

bearerAuth

API token for Zapier integration

TypeHTTP (bearer)

Responses​

All webhooks unregistered successfully
application/json
JSON
{
"success": true,
"message": "string"
}

Playground​

Authorization

Samples​

cURL
JavaScript
PHP
Python

Authentication​

Token validation and authentication

Operations​

GET/token

Validate token​

GET
/token

Check if your API token is valid and get token information

Authorizations​

bearerAuth

API token for Zapier integration

TypeHTTP (bearer)

Responses​

Token is valid
application/json
JSON
{
"success": true,
"message": "string",
"token_name": "string"
}

Playground​

Authorization

Samples​

cURL
JavaScript
PHP
Python

Testing​

Testing and development utilities

Operations​

POST/webhooks/sample

Generate sample data​

POST
/webhooks/sample

Generate sample webhook data for testing purposes. This is useful for testing your Zapier workflows with realistic form data.

Authorizations​

bearerAuth

API token for Zapier integration

TypeHTTP (bearer)

Request Body​

application/json
JSON
{
"form_id": "string"
}

Responses​

Sample data generated successfully
application/json
JSON
{
"success": true,
"message": "string",
"form": {
"id": "string",
"form_id": "string",
"name": "string",
"description": "string",
"created_at": "string",
"updated_at": "string"
},
"webhook_data": {
"id": "string",
"form_id": "string",
"form_name": "string",
"input_data": {
"additionalProperties": "string"
},
"classification": "string",
"submitted_at": "string",
"metadata": {
"user_agent": "string",
"ip_address": "string",
"referrer": "string"
}
}
}

Playground​

Authorization
Body

Samples​

cURL
JavaScript
PHP
Python
Powered by VitePress OpenAPI

TIP

If the API specification doesn't load, please check the browser console for any errors.