Workspace vs. External Apps
The integration process is all about apps and connecting them with each other. Here on Integry, you need to first set up and configure your app before everything. Once your app is configured, you can then create templates with it and connect it with other apps.
You can also create multiple apps and work on them independently. There are two types of apps that you can create. Both serve two distinct purposes.
These are the apps that are created to be involved in integrations on the Integry platform. These require proper configuration, like setting up authorizations, activities, endpoints, etc. You can use these apps in templates and create workflows with them. These apps have their own workspaces, and you can add templates to each workspace. Your own app that you set up on Integry should also be a workspace app.
External apps are the ones that you have created integrations with on platforms outside of Integry. These are only placeholder apps on Integry and their main purpose is to direct your users to the external link on which they can set up that integration. On your integrations listing page (App Directory or embedded SDK), these apps appear alongside integrations templates. Clicking on them takes the user to their external link.
External apps do not require an extensive configuration. You just need to provide their basic info, product info, and the action URL.
Both types of apps appear in their own categories in the Apps menu on your Integry dashboard. An example is shown below. The external apps are categorized as Your Apps.
Configuring Your App's Basic Info
The app creation process is the first step for building integrations at Integry. Let's see how to start the app creation process.
Once you log in to Integry, click on the Apps tab on the top of your dashboard. Here, you can see the apps that you have already created. To create a new app, click the Create an App button.
You will then be asked for the type of app that you want to create.
Choosing the Integry App will take you to the creation of a workspace app. Clicking the External App option will take you to its own setup page.
Let's first talk about the information you have to provide if you choose to create the workspace app. Once you choose this option, you'll land on this setup page:
The first step is to fill in the meta data of your app. The New App page shown above asks for the following information.
- App Name: The name of your app.
- Short Description: A brief introduction of your app.
- Long Description: The detailed description about the idea, need, functionalities, and features of your app.
- App Capabilities: The features and functionalities your app will provide to other apps it integrates with.
- App Branding: The app logo and color.
- Email Notification Icon: The icon of the app to be used in email notifications. You can decide what logo you want to show your users in emails related to this app's integrations.
- Background color: The background color to be used for your app's logo.
- API Base URL: This is the app's API URL where all calls in the future will be sent and received from.
You can provide multiple Base URLs. An app can also have multiple capabilities.
The Base URL provides the app with a server where the apps can fetch various resources. For example, the base URL to your API is https://myapi.com. For your activities, you need to fetch the list of projects and messages. The path to projects and messages being https;//myapi.com/projects and https://myapi.com/messages. You enter the constant part https://myapi.com as Base URL. When you create endpoints, you select the Base URL and provide the dynamic part.
If you choose to create an external app, the basic info page for it will be slightly different. This is the page you'll be directed to:
Here is the information that this page asks from you:
- Title: The name of the app.
- Description: The description of the external app and its integration that you want your users to know about.
- App Icon: The logo of the app. This is the image that will appear on the external app card on your integrations listing page.
- App Color: The background color to be used with the logo.
- App URL: The link to this app's homepage.
- Action URL: The external link where your users should go when they click on this app. This can be the integration setup page on a third-party platform or anything else you want.
- Enable Product Page: Toggling this will show the app's product page when your users click on it, instead of going to the action URL.
You can clone your app, to introduce new features to it or move your app between different environments by just changing the Base URL. You can also create multiple versions (staging, production, etc.) of your app and shift your templates between those workspaces.
Once these basic info details are filled for your app, click the Create App button and your app is added to our platform.
Start setting up your new app page here.
For external apps, you still need to fill up the Product page to finalize that app's creation. For a workspace app, a lot of detail and work is still needed after the basic information. The points you need to set up are:
- App Authorization
- Adapters (optional)
- Queries (optional)
- Product page (including App Interface, Legal Documents, Social Media connections and more)