🎉 Early Access Deal — 40% off locked in forever. First 200 customers only.

Claim your spot →

Webhooks & API Requests Guide

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
Webhook On
  • WooCommerce Orders
  • Payment Notifications

Step 1: Create a Webhook Trigger

  1. Zaplane Dashboard → Workflows
Zaplane Dashboard
  1. Create a New Workflow or open an existing one.
Create a New Workflow
  1. Select Webhook as your Trigger app.
Workflow Tigger Select App
Add Typeform
Action Select Setting

Step 2: Copy the Webhook URL

Once the Webhook Trigger is added, Zaplane will generate a unique Webhook URL.

Example Format:

https://yourwebsite.com/wp-json/zaplane/v1/incoming/webhook-id
  • Click the Copy URL button to save it to your clipboard.
Action Configure

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. 

Typeform Dashboard
Connent Webhooks Dashboard
Add Webhook URL

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

  1. Open the Workflow Editor.
  2. Click the Add Action button.
  3. Select the HTTP Request action.
Select the HTTP Request action

Step 2: Configure the API Request

Now, configure the settings for your API Request.

configure HTTP settings

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