App development

Create new apps and fork existing ones in Middle's developer portal

Apps allow you to sync records and perform actions. ENTERPRISE customers can create and edit apps all within Middle's developer dashboard. Since all Middle integration code is open-sourced, you are able to review the code powering your Middle instance's apps. All apps are coded in Python.

Apps are managed on an instance-by-instance basis. That means that if you add an app to your Middle installation it will only be visible to you unless you'd like it to be publicly available to others.

To access your instance’s apps, click the Apps tab.

Your Middle instance's menu bar

This tab will show all installed apps that currently exist in your Middle instance. This dashboard will also allow you to create or upload an app.

Elements of an app

There are four main elements to a Middle app:

• Authentication defines what's needed for an app to work and gain authorization to access the systems you are integrating with
• Record types are data synced into Middle, I.E. Middle's inputs
• Actions are typically Middle's "Outputs": how data flows out of Middle
• Code packages are referencable by your record sync and action code to open libraries, use functions, etc., and not have to repeatedly embed this in your code

The steps of app development

There are seven steps to building a new app:

1. Create a new app

2. Configure app settings

3. Configure authentication (authorization)

4. Create record types and poll syncs (inputs)

5. Create actions (outputs)

6. (Optional) upload code packages or helper functions

7. Test your app

Creating a new app

To integrate with a system that is not already available on the platform, you must create a new app on your Middle instance.

To create a new app, click + Create an app in your app portal.

This will create a new app and bring you to the new app's dashboard.

Click to create a new app

Once your app is in use, this dashboard will begin to report metrics about worker queues and sync attempts. It will also contain a Download button to download a zipped JSON copy of your app, which can be generated using the Regenerate button.

An app's dashboard

Configure App Settings

First, you will need to configure the app’s settings.

If you plan to make your new app public, it is important for people to understand the purpose of the app, the system it's integrating to, and any important notes for developers who may need to work with the app in the future.

To configure your app's settings, click Settings from the left-hand navigation menu.

There are two levels of app visibility: hidden, and public. Turning this toggle on will make this app visible for Accounts to connect to.

Set a toggle to make an app visible to all accounts

You will also be able to name your app, provide app descriptions, and add any important notes about the platform you are integrating with. Here's an example of what these fields could look like for our new app: "CoolNewApp."

Cosmetic settings for your new app

Once you have filled out your app's settings, click Save.