Welcome! This guide will show you how to make Integration part of your own solution. We will follow three easy steps, starting with picking a connector, followed by building a template and then checking out the Marketplace. Ready? Let's go!
<aside> 💡 Please Note: If you want to test a real data flow, you will need credentials and potentially an Auth Client for the setup. You can build a template with fake data of course, if you just want to see what it looks like. Just keep in mind that for a real test, you need real access.
</aside>
Navigate to the Connectors page via the menu or the button on the dashboard. You will see all available standard Connectors. When you click on one you can explore more details, like Triggers & Actions or what Auth Type the application uses.
Choose a Connector to an application you want to integrate with. We suggest to start with an application you know well - that makes it easier to define a flow.
Want to test with your own solution? Start with the REST-Component. It allows you to configure a REST endpoint of your API to use in a flow template. We generally differentiate between application specific connectors and more generalised, technical ones, that we sometimes refer to as components. Those are more flexible, but require more configuration.
<aside> 💡 What are Templates? The steps necessary to let data flow from one application to another are defined in what we call Integration Flows. You will create a general description of such Integration Flows and make them available for all your users. These pre-defined and re-usable descriptions of Integration Flows are Templates.
</aside>
There are many ways to create a new Template. From the details page of a Connector you can start blank by clicking New Template on the connectors detail page or can choose an action or trigger to have this as one step in your template. If you choose the REST-Component as a Trigger, your template builder will look like this:
When choosing a component like the REST-Component, you will need to provide configuration details before you can proceed. Fill in the fields and then choose an application from the Connector's list on the right as the next step in your flow.
In case the application you like to connect with uses oAuth, you will be asked to setup an Auth Client. You can fill this in with fake data. But remember to update it later (go to Settings → Auth Clients) before activating the template to test the real flow of data.
You will get a drop-down menu of all available actions or triggers. Choose one that makes sense and click continue. This will open the mapping dialog, where you need to match both schemas. Make sure to at least fill in the required fields of the target system to make sure your data will be transformed and transported correctly when you activate the flow.
Click continue to save your template and make it available for your endusers. Congratulations, you created your first template 🎉