n8n-nodes-webhook-wait

A custom n8n node that pauses workflow execution and waits for a webhook call before continuing.

Features

• Customizable Webhook URL: Set any custom path for your webhook
• Multiple HTTP Methods: Support for GET, POST, PUT, PATCH, DELETE, HEAD
• Authentication Options:
  • None
  • Basic Auth
  • Header Auth
• Dynamic Path Generation:
  • Include execution ID in path
  • Include workflow ID in path
• Flexible Response Configuration:
  • Custom response codes
  • Custom response headers
  • Custom response body/message
• Data Handling:
  • Pass through input data
  • Merge webhook data with existing data

Installation

Local Development

1. Clone this repository to your n8n custom nodes directory:

   cd ~/.n8n/custom
   git clone <this-repo> n8n-nodes-webhook-wait
   cd n8n-nodes-webhook-wait

2. Install dependencies:

   npm install

3. Build the node:

   npm run build

4. Restart n8n

Using npm link (for development)

1. In this project directory:

   npm link

2. In your n8n installation directory:

   npm link n8n-nodes-webhook-wait

3. Restart n8n

Usage

Basic Usage

1. Add the Webhook Wait node to your workflow
2. Configure the custom webhook path (e.g., my-custom-webhook)
3. Set the HTTP method (default: POST)
4. Run the workflow - it will pause at this node
5. Send a request to the webhook URL to continue the workflow

Example Workflow

Trigger → Some Processing → Webhook Wait → Continue Processing → End

The workflow will:

1. Start from the trigger
2. Process initial nodes
3. Pause at Webhook Wait and expose a webhook URL
4. Wait for an external call to the webhook
5. Continue with the remaining nodes

Webhook URL Format

The webhook URL will be:

https://your-n8n-instance.com/webhook/your-custom-path

Or with execution ID:

https://your-n8n-instance.com/webhook/your-custom-path/execution-id

Authentication

Header Auth

Set a custom header name and expected value. The webhook will only accept calls that include this header with the correct value.

Basic Auth

Configure username and password. The webhook will require HTTP Basic Authentication.

Configuration Options

| Option | Description | Default | |--------|-------------|---------| | Custom Webhook Path | The path segment of the webhook URL | webhook-wait | | Use Full Path | Use path as full path instead of appending to base | false | | HTTP Method | HTTP method to listen for | POST | | Response Code | HTTP status code to return | 200 | | Response Data | What data to return in response | No Response Body | | Include Execution ID | Append execution ID to path | false | | Include Workflow ID | Append workflow ID to path | false | | Pass Through Input Data | Merge input with webhook data | false | | Timeout (Minutes) | Max wait time (0 = infinite) | 0 |

Response Data Options

• All Entries: Return all webhook data (headers, body, query, params)
• First Entry JSON: Return only the request body
• First Entry Binary: Return binary data if present
• No Response Body: Return empty response
• Custom Response: Return a custom JSON message

License

MIT