Getting Started

To build your first integration use case with any number of external apps, you need to:

1. Select apps you want to integrate with.
2. Connect your app to our platform.
3. Add integration logic and UI to your product code using our universal building blocks
4. Generate app-specific implementations for the building blocks you used.

Let's do it step by step.

1. Connect External Apps

1.1. Add external apps

To start, select one or more external apps you want to integrate with. You can do it from the Apps page.

To keep things simple, start with an app that:

• Has a pre-built connector (most popular apps do).
• You have an account with.

If you are not sure which app to start with, try Hubspot.
It has a free tier and lets you test most of the features you may need (like custom fields or webhooks).

1.2. Configure connector parameters (optional)

Some apps require you to provide parameters for a connector such as your OAuth client ID and secret.
We constantly work to make integrations zero-config by providing default parameters, so chances are you can just skip this step.

You can tell whether you need to provide additional configuration by checking the status of the app. If it's red - you are missing something and can find details in the error message:

2. Connect your app

You can use integrations both on your front-end and back-end

At the very least, you need to do the following:

2.1. Set up a front-end SDK

To connect your customer accounts and use integrations from your front-end, you need to install an SDK. You can choose from one of these options:

2.2. Create a Connection

Before running integrations, you need to connect your customer's account in an external application. It creates a Connection object that stores and refreshes the customer's credentials.

You can use one of our pre-built UI components (recommended for quick start) or build a fully custom UI.

You can see the list of all the customer connections on the Connections page.

3. Add integration logic and UI

To make integrations available to your customers, you need to add them to your app.

We offer a large variety of building blocks and UI components you can use, and you can always use custom code if none of them fit your needs.

To get started fast, we recommend adding one of the common pre-built scenarios you can find on the Scenarios page.

After adding a scenario, you will see a ToDo list with the steps to add it to your app:

If none of the pre-built scenarios work for you, you can always start from scratch.
We have prepared a guide on how to choose the right way for building your use case: Interfaces.

4. Generate app-specific implementations

Whenever your app interacts with external apps, you do it through one of the universal building blocks.
You can generate any number of app-specific implementations for building blocks:

If our platform has enough information about a given app through its connector, we will automatically generate an app-specific implementation for the building block.
If not, you can fill the gaps via console or in the IDE of your choice.

Next Steps