Zaplane allows you to exchange data seamlessly with any third-party app, service, or custom system. It primarily functions in two ways:
- Incoming Data: Webhook Trigger
- Outgoing Data: API Request Actaion
This guide provides a step-by-step walkthrough on how Webhooks and API Requests work and how to set them up.
1. Webhook Trigger (Receiving Data from External Apps)
Use a Webhook Trigger when you want data to be sent automatically from an external app to Zaplane.
Common Examples:
- Typeform Submissions
- Google Sheets Updates
- Custom Form Submissions

- WooCommerce Orders
- Payment Notifications
Step 1: Create a Webhook Trigger
- Zaplane Dashboard → Workflows

- Create a New Workflow or open an existing one.

- Select Webhook as your Trigger app.



Step 2: Copy the Webhook URL
Once the Webhook Trigger is added, Zaplane will generate a unique Webhook URL.
Example Format:
- Click the Copy URL button to save it to your clipboard.

Step 3: Setup Webhook in External App
Go to the Webhook Settings of your source app and paste the Zaplane Webhook URL there.
Examples:
- Typeform Webhook Settings
- Stripe Endpoints
- Custom API Callback URLs
Typeform Dashboard → Your Form → Connect → Webhooks → Add a webhook → Paste & Save.



2. API Request Action (Sending Data to External Apps)
If you want to send data to an external app or API at any step of your workflow, you must use the API Request Action. This is also commonly known as an HTTP Request or API Action.
Step 1: Add API Request Action
- Open the Workflow Editor.
- Click the Add Action button.
- Select the HTTP Request action.

Step 2: Configure the API Request
Now, configure the settings for your API Request.

Method
Select the appropriate HTTP Method based on your requirements:
|
Method |
Purpose |
|
GET |
To read or retrieve information |
|
POST |
To create new data |
|
PUT |
To update entire existing data |
|
PATCH |
To update partial data |
|
DELETE |
To delete data |
URL
Enter the API Endpoint URL where you want to send the data.
- Example: https://api.example.com/users
Headers
API Authentication headers are usually added here.
- Example:
- Authorization: Bearer YOUR_ACCESS_TOKEN
- Content-Type: application/json
Body (Request Payload)
You can send data here in JSON format. You can also use data from previous workflow steps as Dynamic Variables.
- Example:
JSON
{
  "name": "{{trigger.name}}",
  "email": "{{trigger.email}}"
}3. General HTTP Method Table
|
Method |
Function |
Example Use Case |
|
GET |
Collect information |
Viewing a User Profile |
|
POST |
Create new data |
Creating a new Customer |
|
PUT |
Update entire data |
Updating a full Profile |
|
PATCH |
Partial update |
Changing only a Phone Number |
|
DELETE |
Delete data |