Webhook
Category: Integration
Node id: webhook
Sends HTTP webhook requests with configurable method, headers, authentication, and retry logic
What it does
- Sends HTTP requests with configurable method (GET/POST/PUT/PATCH/DELETE/HEAD)
- Multiple content types: JSON, form-urlencoded, plain text, XML
- Authentication: Bearer token, Basic auth, API key
- Configurable retry logic with delay between attempts
- Custom HTTP headers from config or input (input overrides config)
- Automatic JSON response parsing with raw body fallback
- Configurable request timeout
Use cases
- Send pipeline results to an external webhook endpoint
- Notify third-party services of completed data processing
- POST FHIR resources to external healthcare systems
- Trigger downstream workflows in other platforms via HTTP
Runtime
- Performance tier:
variable
Input ports
| Name | Type | Required | Description |
|---|---|---|---|
url | text | No | URL to send the webhook to (overrides config) |
body | any | No | Request body payload |
headers | json | No | HTTP headers to include (overrides config headers) |
Output ports
| Name | Type | Required | Description |
|---|---|---|---|
result | json | No | Full webhook response with status_code, status, headers, body, and body_raw |
success | boolean | No | Whether the request succeeded |
Settings
Basic
| Setting | Name | Type | Required | Default | Allowed values | Description |
|---|---|---|---|---|---|---|
| URL | url | string | Yes | Webhook URL to call | ||
| HTTP Method | method | enum | No | POST | GET, POST, PUT, PATCH, DELETE, HEAD | HTTP method to use |
| Content Type | content_type | enum | No | application/json | application/json, application/x-www-form-urlencoded, text/plain, application/xml | Request content type |
Auth
| Setting | Name | Type | Required | Default | Allowed values | Description |
|---|---|---|---|---|---|---|
| Auth Type | auth_type | enum | No | none | none, bearer, basic, api_key | Authentication type |
| Bearer Token | auth_token | secret | No | Bearer token for authentication | ||
| Username | auth_username | string | No | Username for basic authentication | ||
| Password | auth_password | secret | No | Password for basic authentication | ||
| API Key | api_key | secret | No | API key value | ||
| API Key Header | api_key_header | string | No | X-API-Key | Header name for API key |
Advanced
| Setting | Name | Type | Required | Default | Allowed values | Description |
|---|---|---|---|---|---|---|
| Headers | headers | json | No | Custom HTTP headers as key-value pairs | ||
| Body | body | json | No | Request body (used if no body input is connected) | ||
| Timeout (seconds) | timeout | number | No | 30 | min 1 | Request timeout in seconds |
| Retries | retries | number | No | 0 | min 0 | Number of retry attempts on failure |
| Retry Delay (seconds) | retry_delay | number | No | 1 | min 0 | Delay between retries in seconds |
Errors
| Code | Description |
|---|---|
MISSING_URL | URL is required but was not provided in config or input |
REQUEST_FAILED | HTTP request failed after all retry attempts |
AUTH_TOKEN_MISSING | auth_token is required for bearer authentication but was empty |
AUTH_CREDENTIALS_MISSING | Username and password are required for basic authentication |
HTTP_ERROR | Server returned an HTTP status code >= 400 |
Runtime notes
- HTTP 4xx/5xx responses cause the node to error — check status_code in result only on success
- Input headers override config headers by key; both are merged into the final request
- body_raw is always a string; body is parsed JSON if possible, otherwise falls back to the raw string
- Retries use a fixed delay (retry_delay seconds) between attempts with no exponential backoff
See Build any workflow for how to put nodes together and Ports, types and data flow for how port types connect.
Etwas unklar? Senden Sie Feedback zur Dokumentation per E-Mail..