This documentation applies to older versions of WSO2 ESB connectors. To find the documentation relevant to the version you are using, select the connector from the WSO2 Connector Store and click Documentation.

All docs This doc

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.


  1. Research the APIs provided by the service for which you want to create a connector.
  2. Decide on the API you are going to use to write the connector. For example, JIRA provides a REST API and Java API. If you choose the REST API, you can create your connector and operations entirely from XML configuration files. If you choose a Java API, you create XML configuration files that define your connector and point to your Java classes that define the operations. 
    Based on the API you are going to write the connector, it can belong to one of the following categories:

    • REST-based connectors
    • SOAP-based connectors
    • Java API-based connectors


    Rest based connectors are preferred if the API vendor provides one.

  3. Start writing the connector using the connector core libraries available with WSO2 ESB. For each connector, you need to have the init() method so that users can manage authentication with the vendor API. This can be a call to the external API or simply setting the access tokens within the ESB context to be used by other methods.


    We strongly recommend the non-use of GPL or LGPL licensed libraries in the development of connectors. If there is a reason to use these licenses, the reason needs to be provided along with the connector submission. Hosting connectors that use GPL or LGPL licenses in WSO2 Connector Store will be done at the sole discretion of WSO2 and provision of a reason for the use of GPL LGPL licensed libraries does not guarantee hosting such connectors.

    For more information on writing connectors, see  Writing a Connector.