The Airkit console is the part of the platform provides access to Org-level material, making it possible to configure application resources, connect external integrations, and access all applications that have been created within the relevant Organization.
On the leftmost side of the console is the Tree, which allows you toggle between different sections within the console. The contents of the selected section is displayed in the Stage to the immediate right of the Tree. Clicking on individual elements within the Stage opens the Inspector, which displays more details about the element being inspected:
In this document, we'll discuss each tab accessible in the Tree, explore the functionality of the associated contents, and dive deeper into the structure of the Stage.
- Structure of the Stage
Structure of the Stage
While the layout of the Stage varies depending on which section has been selected, there are some features that remain whenever applicable. This section discusses what they are and how to use them.
'Create New' Button
Many tabs have a 'Create New' Button in the upper right:
Clicking this button opens the Inspector, which provides the interface to create a new instance of the the tab-relevant item. For instance, if the Apps tab is open, this button creates a new app, whereas if the Resources tab is open, this button creates a new resource.
To the upper left of the Stage is the search bar and the 'Sort' button. If present, the 'Filter' button will rest between them:
These make it possible to explore and organize the items stored under a particular tab.
- Search - Search for an item by name
- Filter - Filter items so that only items with a specified traits will appear in the Stage
- Sort - Sort items according to the value held in a particular column.
The effects of the 'Sort' button can be replicated by clicking directly on the column name:
Apps - Create and access all the apps associated with the relevant Organization.
Clicking anywhere on the row designating an app opens up the Inspector, where you can view the app's status, edit the app's name or description, open the app in the Studio, or even delete it.
This is the section that will be opened automatically upon logging into an Organization.
Activity - View the logged events and metrics associated with all of the Organization's apps.
To view metrics associated with a particular app, select it from the dropdown menu on the upper right:
There is no 'Create New' button under Activity. This section of the console is not meant to be part of building directly; it is meant to display data regarding what has already been built.
Datastores - View a list of the Datastores connected to your Organization.
Clicking on one opens the Inspector, which displays information regarding which apps reference the Datastore, as well as the schema of the App Objects stored within.
Using this information, it is possible to share custom data objects between different applications in your organization.
Integrations - Define connections with the outside world.
This is the section you'll use to configure how external data sources will be authenticated. Once authenticated, you can use it across your applications, whether as part of an HTTP request, a control, or a Data Operation.
There are two subcategories under Integrations: Connected Accounts and Custom Integrations.
Connected Accounts - Provide credentials that allow you to integrate with a configured external source
Connected accounts can be used to create connections in Connection Builder that retrieve or send data to these connected accounts.
Custom Integrations - Configure external sources
These external sources can be accessed under Connected Accounts (see above) to provide credentials for a particular account. The process of using a custom integration is first defining what the integration should look like in the custom integrations section and then adding a credential for the integration in the Connected Accounts section.
Currently supported custom integrations are:
- OAuth 2.0 - Use OAuth and configure all the needed properties.
- API Token - Standard API token implementation.
- HTTP - Basic Auth Basic Username and password HTTP Auth.
- Custom Token - Specify custom parameters to retrieve a token.
- SFTP - Specify a username and password or private key for authentication.
Resources - Connect to specific external resources like phone numbers and web domains.
This is where you'll define the external resources used to interface directly we app users, such as:
- Phone Numbers - used to send and receive calls and text messages.
- Domains - define the web domain of links to Airkit web apps.
- Embeds - defines the means to embed published Airkit apps into existing web pages.
For more on adding and modifying resources, check out this article.
API - Tell external sources how to recognize and authenticate your Airkit apps.
The Integrations and Resources sections tell your apps how to recognize and authenticate external sources. The API section tells external sources how to recognize and authenticate your Airkit apps. This is primarily done in two ways: tokens and web hooks.
Tokens - Create and view web tokens as needed.
Tokens will be displayed only at the time of creation. You will be able to use this token when connecting between external resources and Airkit with an Airkit App API. It is also possible to connect multiple Airkit Apps together in this fashion.
For a more detailed walkthrough of how create and use tokens, check out Securing API Endpoints with Airkit API Tokens Permissions.
Webhooks - Configure Webhooks
Webhooks are used to create datasources and resources in your Organization.
Modify settings pertaining directly to your account, Organization, and security. Note that not every role has the needed permissions to access every one of the following subsection; for more on the permissions given to each type of user, check out Managing User Roles.
When inviting a new user, selecting the SSO Only checkbox will use the user’s Google OAuth credentials (if applicable) to log in. The user can log in using an assigned username and get to set a password themselves. If a username is not assigned, the invited user will be allowed to set their own.
For more on this section, check out Adding Users to Airkit.
View and modify information related directly to your Organization, including how your Org appears on the platform and the authorization credentials required to access it.
Logs & Notifiers
Specify Organization-level notifications and logs. Logs can be stored in an S3 bucket. Notifiers can send alerts via Slack, email, or a custom Webhook when n app produces an error.
Create and manage encryption keys. For more on how to create and use encryption keys, check out Encrypting Data.
View your account and security information.