Kafka rule

You can use a Kafka rule to send data such as messages, occupancy, lifecycle and presence events from Ably to Kafka.

If you want to send data from Kafka to Ably, you can use the Ably Kafka Connector, rather than Kafka rules.

Development status

This feature is Enterprise only.

Creating a Kafka rule

There are two ways to create a Kafka rule:

1. Using the Ably Dashboard.
2. Using the Control API.

Creating a Kafka rule in the dashboard

To create a rule in your dashboard:

1. Login and select the application you wish to integrate with Kafka.
2. Click the Integrations tab.


Integrations tab

3. Click the + New Integration Rule button.
4. Choose Firehose.
5. Choose Kafka.


Choose Kafka

6. Configure the settings applicable to your use case and your Kafka installation.

The general settings:


Kafka rule settings - general

The Kafka-specific settings:


Kafka rule settings - Kafka-specific

In this section you need to set up your Authentication for Kafka by selecting your preferred mechanism for authentication and providing credentials.

The supported Authentication Mechanisms are:

7. Click Create to create the rule.

Creating a Kafka rule using Control API

See some examples of creating rules in the rules section of the Control API documentation. You can also refer to the rule section of the Control API Reference for information on creating a Kafka rule. You will need to select a ruleType of kafka.

See also


Need help?

If you need any help with your implementation or if you have encountered any problems, do get in touch. You can also quickly find answers from our knowledge base, and blog.