Skip to main content

Build Your Own Connector

When no pre-built connector exists for your target service, you can build one yourself. WSO2 Integrator supports two approaches: generating a connector automatically from an OpenAPI specification, or writing one from scratch in Ballerina for full control over authentication, error handling, and data transformation.

When to build a custom connector​

Consider building a custom connector when:

  • No pre-built connector exists for your target service or API in the Connector Catalog
  • You need custom logic beyond what a standard connector provides, such as specialized authentication flows, data transformations, or retry strategies
  • You're integrating with an internal API that is private to your organization
  • You want to publish and share a reusable connector with your team or the broader community

Choose your approach​

WSO2 Integrator offers two ways to build custom connectors:

ApproachBest ForEffort
Build from OpenAPI SpecQuick integration with any REST API that has an OpenAPI definitionLow (no coding required)
Build from ScratchFull control over connector implementation, advanced logic, or publishing to Ballerina CentralMedium (requires Ballerina knowledge)

Build from OpenAPI Spec​

The fastest way to connect to a new API. Simply import an OpenAPI specification file directly in the WSO2 Integrator, and a fully functional connector is generated automatically. No coding required.

Best for: Rapid prototyping, standard REST APIs, internal APIs with OpenAPI specs. Once generated, you can also publish it to Ballerina Central to share it beyond your project.

Build a connector from an OpenAPI spec

Build from Scratch​

Build a connector from scratch using Ballerina. This approach gives you full control over the connector architecture, including custom authentication, error handling, and data transformation logic. You can also publish your connector to Ballerina Central for others to use.

Best for: Complex integrations, reusable organizational connectors, community contributions.

Build a connector from scratch

What's next​