TriggerWorkflow
This task allows you to execute n8n workflows from within Kestra by calling their webhook URLs. See the n8n Webhook Docs for more information on getting started with n8n Webhooks.
This task allows you to execute n8n workflows from within Kestra by calling their webhook URLs. See the n8n Webhook Docs for more information on getting started with n8n Webhooks.
Trigger a n8n workflow via a webhook
This task allows you to execute n8n workflows from within Kestra by calling their webhook URLs. See the n8n Webhook Docs for more information on getting started with n8n Webhooks.
type: "io.kestra.plugin.n8n.webhook.TriggerWorkflow"Examples
Simple Trigger Workflow
id: n8n_webhook_trigger
namespace: company.team
tasks:
- id: trigger_workflow
type: io.kestra.plugin.n8n.webhook.TriggerWorkflow
method: POST
uri: https://n8n.example.com/webhook/213e8fbc-f843-428c-9860-ab9f64e5ef3b
Trigger Workflow With Basic Auth
id: n8n_webhook_trigger_with_auth
namespace: company.team
tasks:
- id: trigger_workflow
type: io.kestra.plugin.n8n.webhook.TriggerWorkflow
options:
auth:
type: BASIC
username: "{{ secret('N8N_WEBHOOK_USERNAME') }}"
password: "{{ secret('N8N_WEBHOOK_PASSWORD') }}"
method: POST
uri: https://n8n.example.com/webhook/213e8fbc-f843-428c-9860-ab9f64e5ef3b
Trigger Workflow With Body
id: n8n_webhook_trigger_with_body
namespace: company.team
tasks:
- id: trigger_workflow
type: io.kestra.plugin.n8n.webhook.TriggerWorkflow
body:
keyOne: valueOne
method: POST
uri: http://n8n:5678/webhook/213e8fbc-f843-428c-9860-ab9f64e5ef3b
Properties
method*Requiredstring
GETPOSTPUTDELETEPATCHHTTP Method
HTTP request method for the webhook call. n8n supports DELETE, GET, HEAD, PATCH, POST, and PUT methods. Choose the method that matches your n8n webhook configuration.
uri*Requiredstring
n8n webhook URL
The webhook URL endpoint from your n8n workflow. Use the Test URL for development or Production URL for live workflows.
bodyobject
Request Body
JSON data to send in the request body. Maximum payload size is 16MB. Use this for POST, PUT, or PATCH requests to send structured data to the n8n webhook.
contentTypestring
BINARYTEXTJSONXMLBINARYContent Type
Format of the request body data. Choose BINARY for files, JSON for structured data, XML for XML documents, or TEXT for plain text content.
fromstring
File Source URI
URI pointing to a file in Kestra storage to send as the request body. Use this instead of 'body' when sending binary data, files, or large content to the n8n webhook.
headersobject
HTTP Headers
Custom HTTP headers to include with the webhook request. Headers are useful for authentication, content type specification, or passing additional metadata to the n8n workflow.
optionsNon-dynamic
The 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 authentification 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.
The password for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.
The username for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.
durationdurationThe time an idle connection can remain in the client's connection pool before being closed.
UTF-8The default charset for the request.
java.nio.charset.Charset
trueWhether redirects should be followed automatically.
ALLTRACEDEBUGINFOWARNERROROFFNOT_SPECIFIEDThe log level for the HTTP client.
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODYThe enabled log.
The maximum content length of the response.
The proxy configuration.
io.kestra.core.http.client.configurations.ProxyConfiguration
DIRECTDIRECTHTTPSOCKSThe address of the proxy server.
The password for proxy authentication.
The port of the proxy server.
DIRECTHTTPSOCKSThe type of proxy to use.
The username for proxy authentication.
durationdurationThe maximum time allowed for reading data from the server before failing.
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
durationThe time allowed to establish a connection to the server before failing.
PT5MdurationThe time allowed for a read connection to remain idle before closing it.
queryParametersobject
Query Parameters
URL query parameters to append to the webhook URL. These parameters will be available in the n8n workflow as part of the incoming request data.
waitbooleanstring
trueWait for Response
Whether to wait for the n8n webhook response. When true, Kestra waits for the workflow to complete according to the response mode configured in n8n (immediate, deferred, or streaming).
