Skip to content
Release: Australia · Updated: 2026-03-12 · Official documentation · View source

Configure ServiceNow Kafka Consumer

Retrieve events pertaining to the specified topics and store it in the required ServiceNow tables.

Before you begin

Procedure

  1. Navigate to All > Process Automation > Kafka Consumer.

  2. Click New.

  3. On the form, fill these values.

    FieldDescription
    NameName to identify the record.
    Broker Connection AliasConnection alias of the Confluent Kafka REST Proxy Spoke.
    TopicTopic from which you want to retrieve the events.
    Robust Transformer DefinitionRobust Transformer Definition that is used for the event transformation and data storage in ServiceNow tables. For information, see Robust Import Set Transformers.
    Offset Starting PointValue of the Kafka Consumer auto.offset.reset. This specifies what the Kafka Consumer should do when there is no initial offset or if the current offset does not exist any more on the server. See the Kafka 2.7 documentation for more information.
    Partitions per groupNumber of partitions per consumer thread.
    Page size (bytes)Maximum size of a request.
    Page limitMaximum number of requests per iteration.
    Embedded FormatFormat of the Kafka message for the topic.
    Request timeout (ms)Value of the Kafka Consumer consumer.request.timeout.ms. This specified the maximum amount of time the client waits for the response of a request. See the Kafka 2.7 documentation for more information.
    Stop Upon Transform ErrorsOption to stop listening when transformation errors are encountered.
    Verbose transformationOption to log all the imported events to import set and produce additional debug logs for transformation.

    Note: You must create one Kafka Consumer record for each topic.

  4. Click the Start Sink Listener related link.

    The Kafka Partition Group Listener States table is populated with the topic partition data.

  5. If you want to stop listening, click the Start Sink Listener related link.

  6. Navigate to System Scheduler > Scheduled Jobs.

  7. Open the record, Kafka Consumer Trigger.

  8. From the Trigger Type list, select Interval.

  9. Click Update.

Parent Topic:ServiceNow Kafka Consumer