Skip to content

Latest commit

 

History

History
 
 

connectors

Camunda out-of-the-box connectors

Find the user documentation in our Camunda Platform 8 Docs

Test locally

Run unit tests

mvn clean verify

Test with local runtime

Use the Camunda Connector Runtime to run your function as a local Java application.

In your IDE you can also simply navigate to the LocalContainerRuntime class in test scope of the default-bundle module and run it via your IDE.

Element Template

The element templates can be found in the element-templates directory of each connector.

Example: aws-lambda/element-templates

Development guidelines

Create a new Connector

To create a new Connector, simply use the script or generate a new project from the Maven archetype.

Execute from the repository root directory:

./add_new_connector.sh ${YOUR_CONNECTOR_NAME}

Substitute ${YOUR_CONNECTOR_NAME} with the name of your new Connector. Please provide the name in a short format: e.g. use simply slack, not connector-slack.

The script will create a Maven sub-module in the connectors directory. You will likely need to import the project in your IDE manually.

Add new Connector to the bundle

As a next step, please include your Connector in the connectors bundle.