Skip to content

Webhook

Node: webhook · Full type: n8n-nodes-base.webhook · Version: 2.1

Ergonomic keyword available: TRIGGER webhook — see NFLOW.md for shorter syntax.

Credentials

httpBasicAuth (alias: @http) / httpHeaderAuth (alias: @http) / jwtAuth (alias: @jwt)

CREDENTIAL @http = httpBasicAuth "My Webhook"

Parameters

Parameter Type Default Details
multipleMethods boolean false
httpMethod options "GET" DELETE, GET, HEAD, PATCH, POST, PUT
path string ""
authentication options "none" basicAuth, headerAuth, jwtAuth, none
responseMode options "onReceived" onReceived, lastNode, responseNode
responseCode number 200
responseData options "firstEntryJson" allEntries, firstEntryJson, firstEntryBinary, noData
responseBinaryPropertyName string "data" required
options collection {} keys: allowedOrigins, binaryData, binaryPropertyName, ignoreBots, ipWhitelist, noResponseBody, ...

options children:

Parameter Type Default Details
allowedOrigins string "*"
binaryData boolean false
binaryPropertyName string "data"
ignoreBots boolean false
ipWhitelist string ""
noResponseBody boolean false
responsePropertyName string "data"
binaryPropertyName string "data"
rawBody boolean false
rawBody boolean false
responseCode fixedCollection {...} groups: values
responseContentType string ""
responseData string ""
responseHeaders fixedCollection {} groups: entries

Example

NODE "webhook" @http AS "Webhook" {
  responseBinaryPropertyName: {{ $json.responseBinaryPropertyName }}
}