Skip to main content
Broker connectors are named, reusable connection profiles that Devset stores locally and makes available to your workflows. Instead of embedding broker addresses and credentials directly in a workflow definition, you create a connector once and then reference it by name. This keeps your workflows portable and makes it easy to point the same workflow at a different broker — development, staging, or production — by swapping a single value.

​
Add a Connector via the Settings UI

1

Open Settings

Navigate to Settings in the Devset UI (http://localhost:8082).
2

Select the Brokers tab

Click the Brokers tab at the top of the Settings page. Any connectors you have already created are listed here.
3

Fill in the connector form

Click Add Connector, choose your broker type (Kafka or RabbitMQ), then complete the fields for that type. See the field reference below.
4

Save

Click Save. The connector appears in the list and is immediately available for use in workflow definitions.

​
Connector Field Reference

Use the kafka type when connecting to an Apache Kafka cluster.
​
name
string
required
A unique identifier for this connector. Workflow definitions reference this connector by setting producerName to this value. Use a descriptive slug such as local-kafka or prod-kafka.
​
bootstrapServers
string
required
A comma-separated list of Kafka broker addresses in host:port format. For a local broker this is typically localhost:9092. For a multi-broker cluster, list all seed brokers, for example broker1:9092,broker2:9092.

​
Reference a Connector in a Workflow

Once you have saved a connector, reference it in any workflow step by setting producerName to the connector’s name value. For example, if you created a Kafka connector named local-kafka, your workflow step looks like this: 
{
  "producerName": "local-kafka",
  "topic": "orders.created",
  "payload": { ... }
}
Multiple connectors of the same type can exist simultaneously, which lets you direct different workflow steps to different brokers within the same project.

​
Delete a Connector via the UI

Open Settings → Brokers, locate the connector you want to remove, and click the Delete icon next to it. Deleting a connector does not modify any workflow definitions that reference it by name, so make sure no active workflows depend on the connector before removing it.
Workflows that reference a deleted connector by producerName will fail at runtime. Update or remove those references before deleting the connector.

​
API Reference

You can manage broker connectors programmatically using the Devset REST API.

​
Create a Connector

curl -X POST http://localhost:8082/connectors/configurations \
  -H "Content-Type: application/json" \
  -d '{
    "type": "kafka",
    "name": "local-kafka",
    "bootstrapServers": "localhost:9092"
  }'

​
List All Connectors

curl http://localhost:8082/connectors/configurations

​
Delete a Connector

Replace {type} with kafka or rabbit, and {name} with the connector’s name. 
curl -X DELETE http://localhost:8082/connectors/configurations/kafka/local-kafka
All connector data is persisted in Devset’s local SQLite database. Back up the database file (or its Docker volume) to preserve your connector configurations across environments.