How-to
Create a connector
A worked example with the wizard, using the sample-data connector
What you'll achieve
A running connector — a managed job that moves data into or out of a topic. This walkthrough uses Datagen Source, which writes sample data into a topic of your choice: perfect for trying things out, and the same wizard applies to every other connector type.
Before you start
- The topic the connector will write to already exists — create one first if needed; the wizard does not create it for you.
- You can authenticate the connector: easiest is selecting a service account your team already has (see the Service Accounts guide); alternatively you paste a Kafka API key and secret.
- Your role badge says Developer or higher and the environment allows changes — in a read-only environment only admins can create connectors.
Steps
- Click Connectors in the sidebar, then Add Connector (bottom-right of the red banner).
- Pick a connector type — use the search box or the All / Source / Sink filter. For this walkthrough click the Datagen Source card.
- In Connector Identifier, type a short descriptive name — the Full Connector Name Preview shows the final name (your business unit and stage are added in front, and -connector at the end).
- Walk the wizard with Next: Topic Selection — pick your topic in the Kafka Topic dropdown. Kafka Credentials — set Authentication Mode to SERVICE_ACCOUNT and pick one, or keep KAFKA_API_KEY and paste the key and secret. Configuration — choose an Output Data Format (pick JSON if unsure) and leave Quickstart Schema on ORDERS. Sizing — leave Max Tasks at 1.
- On Review and Launch, check the summary and click Create Connector.
What success looks like
You land back on the Connectors list with your connector showing a PROVISIONING badge; within a few minutes it turns RUNNING and sample orders start flowing into your topic — check with View messages on a topic. Done experimenting? Pause or delete the connector so it stops producing.
Something went wrong?
- The Kafka Topic dropdown says "No topics available" — create the topic first, then restart the wizard.
- A red banner on the current step like "Kafka Topic is required" — a required field is still empty; fill it before clicking Next.
- A "Leave Setup" window when you click elsewhere — the wizard is protecting your half-finished setup; choose Continue to stay or Leave Setup to abandon it.
- The connector never leaves PROVISIONING or turns FAILED — see Check why a connector is failing.
Background — all connector types and how naming works? Read the Connectors guide.