Each app begins with a name and description.
App Creation
The name should be the proper name of the third-party system that the app represents (“NetSuite”, “SalesForce,” “JetBuilt”). The description should be a description of that platform, which you can also take from the respective company’s website.
.png)
Getting Started
The first thing you will see once you have created an app is a selection of global properties and links to Add Auth and Add APIs.
.png)
Global Properties
Property Name | Description |
|---|---|
ID | This is an auto-generated unique ID for the app. Use the default value unless there is specific need to change it. |
Type | This defines which type of app you are building, whether it is an Action (a majority, and the default value), a trigger app, or an input app.
|
Category | This defines the category of the app. Unless you are building a function app, this should retain the default value of “App.”
|
Icon | Here you place the URL to the icon of the third-party app. For example: https://airtable.com/images/favicon/baymax/apple-touch-icon.png |
Hidden | This is used to determine whether or not the app will appear within the list of available apps. The default value is “false.” |
Component | If you are building a component with a custom UX for this app, enter the name of the component here. |
Default Auth Type | This defaults to the first Auth created for the app. If you have multiple and need an app other than the first to be the default, you can change it here. |
Deploy Component | If you are building a component with a custom UX for this app, enter the name of the component here. |
Action Grouping | If you have placed actions into groups (such as “Contact Operations,” “Transaction Operations,” etc.), you can set this to “Enabled.” |
.png "image(7).png")
.png "image(8).png")
Documentation
Property Name | Description |
|---|---|
Website | This is where the external platform’s website goes (i.e. https://airtable.com) |
API Docs | This is where the link to the external platform’s API docs go (i.e. https://airtable.com/developers/web/api/introduction) |
OpenAPI Spec | If the company has an OpenAPI spec, link to it here. |