Kafka Trigger

Node: kafkaTrigger · Full type: n8n-nodes-base.kafkaTrigger · Version: 1.3

Credentials

kafka (alias: @kafka)

CREDENTIAL @kafka = kafka "My Kafka Trigger"

Parameters

Parameter	Type	Default	Details
topic	string	""	required
groupId	string	""	required
resolveOffset	options	"onCompletion"	onCompletion, onSuccess, onStatus, immediately
allowedStatuses	multiOptions	[...]	multi: canceled, crashed, error, new, running, success, unknown, waiting
useSchemaRegistry	boolean	false
schemaRegistryUrl	string	""	required
options	collection	{}	keys: allowAutoTopicCreation, autoCommitThreshold, autoCommitInterval, batchSize, eachBatchAutoResolve, fetchMaxBytes, ...

options children:

Parameter	Type	Default	Details
allowAutoTopicCreation	boolean	false
autoCommitThreshold	number	0
autoCommitInterval	number	0
batchSize	number	1
eachBatchAutoResolve	boolean	false
fetchMaxBytes	number	1048576
fetchMinBytes	number	1
heartbeatInterval	number	10000
heartbeatInterval	number	3000
maxInFlightRequests	number	1
fromBeginning	boolean	true
jsonParseMessage	boolean	false
keepBinaryData	boolean	false
parallelProcessing	boolean	true
partitionsConsumedConcurrently	number	0
onlyMessage	boolean	false
returnHeaders	boolean	false
rebalanceTimeout	number	600000
errorRetryDelay	number	5000
sessionTimeout	number	30000

Example

NODE "kafkaTrigger" @kafka AS "Kafka Trigger" {
  topic: {{ $json.topic }},
  groupId: {{ $json.groupId }},
  schemaRegistryUrl: {{ $json.schemaRegistryUrl }}
}