Creating connectors

<< Click to Display Table of Contents >>

Navigation:  Bizagi Studio > Integrating external applications from Bizagi > Bizagi connectors >

Creating connectors


Connectors in Bizagi are portable modules that allow you to extend the functionality in terms of integrating to another systems or application, as described at Bizagi Connectors.

In addition to using available connectors from the Connectors Xchange, you can create your own connectors either by modifying any of the existing ones, or by creating it from scratch.

To install or customize a connector already available, refer to Connectors Xchange.


Types of connectors

There are two types of connectors you can create:


1.Assisted REST connectors:

This type of connectors require no code (does not require expert programming skills) since these use a proprietary REST framework (Bizagi Ltd), which connects to those APIs providing standard authentication mechanisms and most common authentication methods.

When possible, you should always create Assisted REST connectors because they will rely on Bizagi features, and therefore make use of best performance and concurrency practices already implemented by Bizagi.




2.Custom connectors:

This type of connectors let you to include any third-party libraries and write your own code (and for instance connect to anything in particular, such as MS Excel).

Should be the choice when the external system's API does not offer a standard or supported authentication mechanism as provided by Bizagi's proprietary framework.




Introducing the Connector Editor

Creating connectors (either Assisted REST or Custom ones) is done easily and by relying on an usable graphic interface provided by the Connector Editor.

The Connector Editor is an online SDK provided by Bizagi Ltd which only requires a browser.


To learn more about the Connector Editor, refer to Connector Editor user interface explained.

To start creating your own connectors, it is strongly recommended that you first go through the considerations described at Connectors concepts and guidelines.



You will not always necessarily need to have a technically-skilled expert profile in order to create connectors.

Though for most scenarios and as a preferred recommendation, it is best to meet with a programmer profile, having:

Basic understanding of XML and JSON structures.

Experience with JavaScript and web application development.

It is optimal and best if you have worked with asynchronous/event-driven coding practices before (e.g jQuery and AJAX).