Webhook Request Node

The Webhook Request Node is used to start a Workflow from an external HTTP call. It allows Zaia Endless to receive data sent by any external system, such as CRMs, websites, or automation platforms.

This node effectively acts as an entry point for external integrations, enabling other systems to trigger a Workflow execution inside Endless.


🛠️ How It Works

When a Webhook Request Node is added to a Workflow, Endless automatically generates a Test URL — a unique endpoint that listens for incoming HTTP requests.

External services (such as form handlers, backend systems, or third-party apps) can send data to this URL using one of the supported methods. Each request can include headers, query parameters, or body payloads that are captured and made available for downstream nodes in the Workflow.

Supported HTTP Methods: GET, POST, PUT, DELETE, PATCH


⚙️ Configuration Options

Setting
Description

Test URL

A unique endpoint automatically generated for the node. Use it to send requests from external systems.

Method

Select the HTTP method the webhook will accept (e.g., POST for JSON payloads).

Allowed Origins

Restricts which domains or sources can call this endpoint. If empty, any origin is allowed.

Authentication Type

Defines how requests are authorized before execution (see below).

Response

Controls how and when Endless returns a response (Immediate or Webhook Response Node).

Response Code

Lets you define the HTTP status code to return (e.g., 200, 201, 400).


🔒 Authentication Options

The Webhook Request Node supports two authentication modes:

1. None

No authentication is required. Any system can trigger the webhook.

Use this mode for testing or public integrations where security is not critical.


2. Bearer Authentication

Secures the webhook using a Bearer Token from a Credential Pool.

When selected:

  1. Choose or create a Credential Pool (type: API Key).

  2. Generate a token inside that pool.

  3. Copy the generated token — it will be required in external HTTP requests.

Example request:

POST https://z-sovereign-service-staging.fly.dev/platform/v1/workflows/capture
Authorization: Bearer 6c8c5187-2f0c-47de-bae0-de22a4855340
Content-Type: application/json

{
  "name": "John Doe",
  "email": "[email protected]"
}

If the request does not include a valid token from the selected pool, Endless will reject it with a 401 Unauthorized response.

⚙️ Credential Pools can contain multiple tokens and can be managed or revoked at any time. This enables secure, centralized credential management for different integrations.


🧪 Node Test Mode

The Node Test feature lets you simulate and validate incoming webhook requests directly inside Endless before deploying the Workflow.

When you click “Execute Test”, the node enters listening mode, waiting for an incoming HTTP request to the generated Test URL. Once a request is received, the panel displays a structured preview of the received data.

Example test output:

{
  "snapshot": {
    "body": {
      "name": "New name",
      "test": "data01"
    },
    "headers": {
      "authorization": "Bearer 6c8c5187-2f0c-47de-bae0-de22a4855340",
      "content-type": "application/json"
    },
    "method": "POST",
    "query": {}
  }
}

After the test completes, you can use this received data as input for subsequent nodes in the same Workflow — ideal for end-to-end testing and schema validation.

🧠 Tip: Use Node Test mode to verify payload structures before integrating production systems. It ensures field mapping and authentication are configured correctly.


🔁 Response Behavior

The Response setting determines when the webhook returns a response:

Mode
Behavior

Immediate

Endless responds immediately after receiving the request, without waiting for the rest of the Workflow to complete.

Webhook Response Node

Endless waits until a dedicated Webhook Response Node executes later in the Workflow — allowing you to return dynamic, processed data back to the requester.

Example use case:

  • Use Immediate for asynchronous triggers (e.g., logging an event).

  • Use Webhook Response Node for synchronous integrations where the external system expects a processed response.


📌 Example Use Cases

Scenario
Description

Lead Capture

Receive a lead from a website form and trigger a workflow to store it in a Table or CRM.

CRM Sync

Capture updates from another system and propagate them across Agents or integrations.

External Event Triggers

Start a workflow when an external event occurs — e.g., a new payment, ticket creation, or API call.

Internal Integrations

Connect Zaia Endless Workflows with internal apps through secure Bearer-authenticated webhooks.


✅ Best Practices

  1. Always use Bearer authentication for production webhooks.

  2. Restrict origins whenever possible to reduce exposure.

  3. Test payloads with the Node Test tool before connecting external systems.

  4. Document response codes expected by the calling system.

  5. Regenerate tokens periodically in Credential Pools for added security.


🧠 Summary

Feature
Description

Purpose

Starts a Workflow via external HTTP call.

Authentication

Supports None or Bearer (via Credential Pools).

Test Mode

Allows real request capture and data inspection inside the node.

Response Handling

Immediate or via Webhook Response Node.

Security

Configurable origins, token management, and credential rotation.


🚀 Final Note

The Webhook Request Node transforms Zaia Endless into an integration hub — capable of receiving data from any system in a secure, controlled, and testable way. With built-in authentication, real-time testing, and flexible response handling, it provides a powerful foundation for building seamless, event-driven automations.

Last updated