---
sourceDocument: Brazil Workflow Data Fabric
sourceDocumentLink: https://www.servicenow.com/docs/r/integrate-applications

 Release :

    - brazil

ft:locale :

    - en-US

ft:publication_title :

    - Brazil Workflow Data Fabric

ft:clusterId :

    - crint

bundleId :

    - crint

workflow :

    - Creator


---

# Configure a Kafka connection

# Configure a Kafka connection {#ariaid-title1}

Release version: Brazil  
Updated September 10, 2026  
![](https://www.servicenow.com/docs/portal-asset/ico-clock) 1 minute to read  
Configure a connection to your Apache Kafka environment.

## Before you begin

* Role required: connection_admin or message_replication_admin
* [Create Kafka credentials](https://www.servicenow.com/docs/uWjTLElv1CZ80xtTJ0Onpw "Configure credentials for your Apache Kafka connection.").
{#configure-kafka-connection__ul_fsk_x5b_qzb}

## About this task

Configure connection and credential records for connecting to your local Apache Kafka environment.

* The connection record contains the information required for making the connection to your local Kafka. Connection records are stored in the Kafka Connections \[kafka_connection\] table.
* The credential record stores the authentication data required for the connection. Credential records are stored in the Kafka credentials \[kafka_credentials\] table.

{#configure-kafka-connection__ul_o2v_rlw_qzb}After you've created both the connection record and the credential record, you can [Create a Connection \& Credential alias](https://www.servicenow.com/docs/access?context=connection-alias&version=brazil&pubname=brazil-platform-security&ft:locale=en-US), which links your connection information and the credential data under a single name.

## Procedure

1. Navigate to AllIntegrationHubConnections \& CredentialsConnections.
2. Select New.
3. On the form asking what type of connection you would like to create, select Kafka Connection.
4. On the Kafka Connection form, fill in the fields.  
   {#configure-kafka-connection__table_pqn_ngv_pzb__entry__2}

   |   |   |
   |-|-|
   | Name | Name for the connection. |
   | Credential | Name of the credential used to authorize this connection. |
   | Application | Application scope for the message replication. This field is automatically set. |
   | Active | Option to activate the connection. |
   | Connection alias | Name of the connection alias to associate with this connection. |
   | Bootstrap servers | Comma-separated list in the format HOST:PORT,HOST:PORT. The list doesn't need to include all of the Apache Kafka cluster servers. |
   | Consumer group id | Kafka consumer group.id. If not provided, the value is created with the format `{instance_name}-consumer-{kafka_connection.sys_id}` |
   | Additional client properties | Any additional client properties that should be specified when connecting to Kafka. For a full list and description of the available properties, see the Kafka documentation at <https://kafka.apache.org/documentation/>. |
   | Use MID Server | Option to use a MID Server. This field is automatically selected. |
   | Advanced MID Server Configuration ||
   | MID Selection | Option to select a specific MID Server or MID Cluster. Options are: * Specific MID Server * Specific MID Cluster {#configure-kafka-connection__ul_jyv_sxn_nfc} |
   | MID Server or MID Cluster | Name of the MID Server or MID Cluster to use. |
   [Table 1. Kafka Connection form]

   {#configure-kafka-connection__table_pqn_ngv_pzb}
5. Select Submit.

## What to do next

[Create a Connection \& Credential alias](https://www.servicenow.com/docs/access?context=connection-alias&version=brazil&pubname=brazil-platform-security&ft:locale=en-US) with a Connection type of Kafka.

*[\>]: and then