TriggerWorkflow

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.

yaml
type: "io.kestra.plugin.n8n.webhook.TriggerWorkflow"

Examples

Simple Trigger Workflow

yaml
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

yaml
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

yaml
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 *string

Possible Values

GETPOSTPUTDELETEPATCH

HTTP 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 *string

n8n webhook URL

The webhook URL endpoint from your n8n workflow. Use the Test URL for development or Production URL for live workflows.

body object

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.

contentType string

Default BINARY

Possible Values

TEXTJSONXMLBINARY

Content 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.

from string

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.

headers object

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.

options HttpConfiguration

The HTTP client configuration.

queryParameters object

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.

wait booleanstring

Default true

Wait 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).

Definitions

io.kestra.core.http.client.configurations.TimeoutConfiguration

connectTimeout string

Format duration

The time allowed to establish a connection to the server before failing.

readIdleTimeout string

Default PT5M

Format duration

The time allowed for a read connection to remain idle before closing it.

io.kestra.core.http.client.configurations.BasicAuthConfiguration

type *object

password string

The password for HTTP basic authentication.

username string

The username for HTTP basic authentication.

java.nio.charset.Charset

io.kestra.core.http.client.configurations.HttpConfiguration

allowFailed booleanstring

Default false

If true, allow a failed response code (response code >= 400)

allowedResponseCodes array

SubType integer

List of response code allowed for this request

auth BasicAuthConfiguration BearerAuthConfiguration

The authentification to use.

defaultCharset Charsetstring

Default UTF-8

The default charset for the request.

followRedirects booleanstring

Default true

Whether redirects should be followed automatically.

logs array

SubType string

Possible Values

REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODY

The enabled log.

proxy ProxyConfiguration

The proxy configuration.

ssl SslOptions

The SSL request options

timeout TimeoutConfiguration

The timeout configuration.

io.kestra.core.http.client.configurations.ProxyConfiguration

address string

The address of the proxy server.

password string

The password for proxy authentication.

port integerstring

The port of the proxy server.

type string

Default DIRECT

Possible Values

DIRECTHTTPSOCKS

The type of proxy to use.

username string

The username for proxy authentication.

io.kestra.core.http.client.configurations.SslOptions

insecureTrustAllCertificates booleanstring

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.

io.kestra.core.http.client.configurations.BearerAuthConfiguration

type *object

token string

The token for bearer token authentication.

​Trigger​Workflow

TriggerWorkflow