> ## Documentation Index
> Fetch the complete documentation index at: https://docs.keephq.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Kafka

> Kafka provider allows integration with Apache Kafka for producing and consuming messages.

## Authentication

This provider requires authentication.

* **host**: Kafka host (required: True, sensitive: False)
* **topic**: The topic to subscribe to (required: True, sensitive: False)
* **username**: Username (required: False, sensitive: True)
* **password**: Password (required: False, sensitive: True)

Certain scopes may be required to perform specific actions or queries via the provider. Below is a summary of relevant scopes and their use cases:

* **topic\_read**: The kafka user that have permissions to read the topic. (mandatory)

## In workflows

This provider can't be used as a "step" or "action" in workflows. If you want to use it, please let us know by creating an issue in the [GitHub repository](https://github.com/keephq/keep/issues).

## Connecting with the Provider

1. Set up a Kafka broker (or use an existing one) and make sure it is accessible.
2. Get the broker URL (e.g., `localhost:9092` or a remote Kafka service URL).
3. (Optional) If using secure communication, provide the security protocol, SASL mechanism, username, and password.
4. Configure the provider with these parameters.

## Usefull Links

-[Kafka Clients Documentation](https://kafka.apache.org/documentation/)