Building your connector using the CLI

This guide explains how to build a Keragon connector using our CLI. Your team writes the connector against our SDK, tests it locally, and submits it when it's ready. The CLI is the right path when your team wants to own the build, usually because your API has quirks worth handling by hand.

 

Getting started

Log in to the partner platform and navigate to the Connectors page. 
If you don't have any connectors yet, click Set up your connector. If you already have existing connectors, click Create new

Step 1: Name your connector

Enter your official product name. This is the name Keragon users will see in the marketplace, so use the real name your customers know you by.

Step 2: Choose how to build

After entering your product name, you'll see two options:

  • Let our AI agent build it: AI generates the connector from your API documentation.
  • Build it yourself: Your team writes the connector using our CLI.

Select Build it yourself to continue.

Step 3: Download the CLI and build the connector

From here, the work happens in your own environment. The dashboard will guide you through downloading the CLI, and our developer documentation covers everything from there: defining your actions and triggers, setting up authentication, running the connector locally, and validating it against your API.

For full instructions, see docs.keragon.com.

While building, you can:

  • Iterate locally without deploying anything to Keragon
  • Test against your own sandbox or test environment
  • Add or refine actions and triggers as you discover edge cases

Step 4: Submit your connector for review

When the connector is ready, submit it for review through the CLI. You can check here the submission instructions.
 



What happens after you submit

The connector doesn't go live immediately. Our team will:

  • Review the code
  • Test the connector against your API
  • Reach out if we need to clarify anything about your API or use cases
  • Publish the connector once it's verified

By the time your connector goes live, it has been verified by both your team and ours.

 

Editing existing connectors

You can use the CLI to update connectors that are already live. Pull the latest version, make your changes: adding actions or triggers, updating authentication, fixing edge cases and resubmit. The same review process applies.

Was this article helpful?
0 out of 0 found this helpful

Articles in this section