N8n TriggerWorkflow
CertifiedCall n8n webhook from Kestra
N8n TriggerWorkflow
Call n8n webhook from Kestra
Invokes an n8n workflow via its webhook URL using Kestra's HTTP client. Default behavior waits for the webhook response and parses JSON when the Content-Type includes application/json; other payloads are returned as text. Non-200 responses fail the task.
type: io.kestra.plugin.n8n.TriggerWorkflowExamples
Simple Trigger Workflow
id: n8n_webhook_trigger
namespace: company.team
tasks:
- id: trigger_workflow
type: io.kestra.plugin.n8n.TriggerWorkflow
method: POST
uri: "{{ secret('N8N_WEBHOOK_URL') }}"
Trigger Workflow With Basic Auth
id: n8n_webhook_trigger_with_auth
namespace: company.team
tasks:
- id: trigger_workflow
type: io.kestra.plugin.n8n.TriggerWorkflow
options:
auth:
type: BASIC
username: "{{ secret('N8N_WEBHOOK_USERNAME') }}"
password: "{{ secret('N8N_WEBHOOK_PASSWORD') }}"
method: POST
uri: "{{ secret('N8N_WEBHOOK_URL') }}"
Trigger Workflow With Body
id: n8n_webhook_trigger_with_body
namespace: company.team
tasks:
- id: trigger_workflow
type: io.kestra.plugin.n8n.TriggerWorkflow
body:
keyOne: valueOne
method: POST
uri: "{{ secret('N8N_WEBHOOK_URL') }}"
Send file payload from storage
id: n8n_webhook_trigger_with_file
namespace: company.team
tasks:
- id: trigger_workflow
type: io.kestra.plugin.n8n.TriggerWorkflow
method: POST
uri: "{{ secret('N8N_WEBHOOK_URL') }}"
from: kestra:///data/uploads/report.pdf
contentType: BINARY
GET webhook with headers and params
id: n8n_webhook_trigger_with_headers
namespace: company.team
tasks:
- id: trigger_workflow
type: io.kestra.plugin.n8n.TriggerWorkflow
method: GET
uri: "{{ secret('N8N_WEBHOOK_URL') }}"
wait: false
queryParameters:
source: kestra
runId: "{{ run.id }}"
headers:
X-Request-ID: "{{ taskrun.id }}"
X-Api-Key: "{{ secret('N8N_API_KEY') }}"
Properties
method *string
GETPOSTPUTDELETEPATCHHTTP method
Request method sent to the webhook. Must match the method configured on the n8n webhook; supports DELETE, GET, PATCH, POST, and PUT.
uri *string
n8n webhook URL
Webhook endpoint from the target n8n workflow. Use the Test URL during development and switch to the Production URL for live runs.
assets
Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset failure behavior
Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150body object
Request body
JSON-compatible data to send in the body. Ignored if from is set. Maximum payload size 16 MB.
contentType string
BINARYTEXTJSONXMLBINARYContent type
Format used for the request body. Default is BINARY for file sends; select JSON, XML, or TEXT when sending structured or textual payloads.
from string
File source URI
Kestra storage URI for the request body. Use instead of body when sending binaries or large content; mutually exclusive with body.
headers object
HTTP headers
Custom headers for authentication, content negotiation, or metadata forwarded to n8n.
options
HTTP client configuration
io.kestra.core.http.client.configurations.HttpConfiguration
falseIf true, allow a failed response code (response code >= 400)
List of response code allowed for this request
The authentication to use.
io.kestra.core.http.client.configurations.BasicAuthConfiguration
The password for HTTP basic authentication.
The username for HTTP basic authentication.
io.kestra.core.http.client.configurations.BearerAuthConfiguration
The token for bearer token authentication.
io.kestra.core.http.client.configurations.DigestAuthConfiguration
The password for HTTP Digest authentication.
The username for HTTP Digest authentication.
UTF-8The default charset for the request.
java.nio.charset.Charset
trueWhether to enable TCP Keep-Alive extended socket options (TCP_KEEPIDLE, TCP_KEEPINTERVAL, TCP_KEEPCOUNT).
Set to false when running on Windows workers, as these extended socket options are not supported by the Windows JDK and will cause connection failures.
trueWhether redirects should be followed automatically.
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODYThe enabled log.
The proxy configuration.
io.kestra.core.http.client.configurations.ProxyConfiguration
The address of the proxy server.
The password for proxy authentication.
The port of the proxy server.
DIRECTDIRECTHTTPSOCKSThe type of proxy to use.
The username for proxy authentication.
Retry strategy for HTTP requests.
retry is disabled by default.
Constant retry
Retry with a fixed delay between attempts.
durationRETRY_FAILED_TASKRETRY_FAILED_TASKCREATE_NEW_EXECUTION>= 1durationfalseExponential retry
Retry with exponentially increasing delays between attempts.
durationdurationRETRY_FAILED_TASKRETRY_FAILED_TASKCREATE_NEW_EXECUTION>= 1durationfalseRandom retry
Retry with a random delay within a configurable range between attempts.
durationdurationRETRY_FAILED_TASKRETRY_FAILED_TASKCREATE_NEW_EXECUTION>= 1durationfalse[502,503,504]HTTP status codes that should be retried.
Used for idempotent methods (GET, HEAD) without their own entry in retryOnStatusCodesByMethod. Non-idempotent methods are never retried on a status code unless listed in retryOnStatusCodesByMethod. Defaults to 502, 503 and 504 for idempotent methods (GET, HEAD) only.
Per-HTTP-method overrides for which status codes should be retried.
Keys are HTTP methods (e.g. GET, POST). A method with no entry here falls back to retryOnStatusCodes. This lets a caller retry more broadly for safe, read-only methods (for example, every 5xx and a 429 for GET/HEAD) while keeping a narrower list for methods that write, where retrying a request that may have already been processed by the origin risks duplicating the effect. Example: {GET: [429, 500, 502, 503, 504], HEAD: [429, 500, 502, 503, 504]}.
["GET","HEAD"]HTTP methods for which any transport-level failure may be retried.
A transport-level failure is a connection or timeout error rather than an HTTP response (e.g. a read timeout or a connection reset mid-request). For a method listed here, any such failure is retried. Defaults to GET and HEAD HTTP methods.
The SSL request options
io.kestra.core.http.client.configurations.SslOptions
Whether to disable checking of the remote SSL certificate.
Only applies if no trust store is configured. Note: This makes the SSL connection insecure and should only be used for testing. If you are using a self-signed certificate, set up a trust store instead.
The timeout configuration.
io.kestra.core.http.client.configurations.TimeoutConfiguration
The time allowed to establish a connection to the server before failing.
PT5MThe time allowed for a read connection to remain idle before closing it.
queryParameters object
Query parameters
Extra query parameters appended to the webhook URL; available to the n8n workflow as request data.
wait booleanstring
trueWait for response
Whether to wait for the n8n response. Defaults to true; respects n8n response mode (immediate, deferred, streaming).
