Skip to main content

Publish Connector

Whether you built your connector from scratch (Build from Scratch) or generated it from an OpenAPI specification (Build from OpenAPI Spec), you can publish it to Ballerina Central to share it with your team or the broader community.

If you generated your connector from an OpenAPI specification directly in a project, package it as a standalone Ballerina project first — see Step 1: Set up the project structure for the expected layout — then continue below.

Update the package metadata​

Update Ballerina.toml with your connector metadata:

[package]
org = "your_org"
name = "myconnector"
version = "1.0.0"
license = ["Apache-2.0"]
authors = ["Your Name"]
keywords = ["integration", "myservice", "Vendor/MyService", "Area/Communication", "Type/Connector"]
repository = "https://github.com/your-username/module-ballerinax-myconnector"
icon = "icon.png"

Keywords for the WSO2 Integration Platform​

The Vendor/, Area/, and Type/ keywords classify your connector in the WSO2 Integration Platform connector catalog. Use the following format:

KeywordPurposeExample
Vendor/<name>The service or company the connector targetsVendor/Salesforce
Area/<category>The functional category of the connectorArea/CRM & Sales
Type/ConnectorMarks the package as a connector (use this fixed value)Type/Connector
Name/<display name>Optional. Use when the display name should differ from the package nameName/Salesforce CRM
note

The WSO2 Integration Platform connector catalog currently lists pre-built WSO2 connectors. Support for community-published connectors is planned, and adding these keywords now ensures your connector is ready when that support rolls out.

Publish to Ballerina Central​

Follow the package publishing guide to publish to Ballerina Central.

What's next​