kafkaTrigger.json•3.84 kB
{
"nodeType": "n8n-nodes-base.kafkaTrigger",
"displayName": "Kafka Trigger",
"description": "Consume messages from a Kafka topic",
"version": [
1,
1.1
],
"properties": [
{
"name": "topic",
"displayName": "Topic",
"type": "string",
"default": "",
"description": "Name of the queue of topic to consume from",
"placeholder": "topic-name",
"required": true
},
{
"name": "groupId",
"displayName": "Group ID",
"type": "string",
"default": "",
"description": "ID of the consumer group",
"placeholder": "n8n-kafka",
"required": true
},
{
"name": "useSchemaRegistry",
"displayName": "Use Schema Registry",
"type": "boolean",
"default": false,
"description": "Whether to use Confluent Schema Registry"
},
{
"name": "schemaRegistryUrl",
"displayName": "Schema Registry URL",
"type": "string",
"default": "",
"description": "URL of the schema registry",
"placeholder": "https://schema-registry-domain:8081",
"required": true,
"displayOptions": {
"show": {
"useSchemaRegistry": [
true
]
}
}
},
{
"name": "options",
"displayName": "Options",
"type": "collection",
"default": {},
"description": "Whether to allow sending message to a previously non exisiting topic",
"placeholder": "Add option",
"options": [
{
"name": "allowAutoTopicCreation",
"displayName": "Allow Topic Creation",
"type": "boolean",
"default": false,
"description": "Whether to allow sending message to a previously non exisiting topic"
},
{
"name": "autoCommitThreshold",
"displayName": "Auto Commit Threshold",
"type": "number",
"default": 0,
"description": "The consumer will commit offsets after resolving a given number of messages"
},
{
"name": "autoCommitInterval",
"displayName": "Auto Commit Interval",
"type": "number",
"default": 0,
"description": "The consumer will commit offsets after a given period, for example, five seconds"
},
{
"name": "heartbeatInterval",
"displayName": "Heartbeat Interval",
"type": "number",
"default": 3000,
"description": "Heartbeats are used to ensure that the consumer's session stays active"
},
{
"name": "maxInFlightRequests",
"displayName": "Max Number of Requests",
"type": "number",
"default": 1,
"description": "The maximum number of unacknowledged requests the client will send on a single connection"
},
{
"name": "fromBeginning",
"displayName": "Read Messages From Beginning",
"type": "boolean",
"default": true,
"description": "Whether to read message from beginning"
},
{
"name": "jsonParseMessage",
"displayName": "JSON Parse Message",
"type": "boolean",
"default": false,
"description": "Whether to try to parse the message to an object"
}
],
"displayOptions": {
"hide": {
"@version": [
1
]
}
}
}
],
"credentialsConfig": [
{
"name": "kafka",
"required": true
},
{
"name": "topic",
"required": true
}
],
"io": {
"inputs": [],
"outputs": [],
"outputNames": [],
"hints": {}
},
"wiring": {
"role": "generic",
"requires": [],
"optional": [],
"consumedBy": [],
"consumes": [],
"produces": []
}
}