Settings is where you configure your apps to associate with external sources. This allows you to do everything from configure the URLs that launch your web apps to authenticate external systems of record. Settings is also where can create different Profiles with access to different resources and app-level configurations, which can be used when deploying the app under different circumstances. Most commonly, different Profiles will be made to ensure that an app deployed for testing and development purposes cannot interact with the outside world in the same way as when deployed to production.
A Profile is a group of configuration settings. When working in Settings, you are making changes to a Profile, and you can select which Profile you are working with by selecting a Profile from the dropdown menu at the top of Settings. By default, every Airkit app comes out of the box with three Profiles: Dev, QA, and Production:
Whenever you deploy your app, you'll have the option of using any of the available Profiles. This allows different deployments of your app to incorporate themselves differently with the outside world. For instance, depending on your needs, different deployments of you application might send text messages from different phone numbers, be accessed through different URLs, or integrate with different systems of record. Each of your Airkit apps might have any number of different Profiles, and you can add new Profiles by clicking on the '+' icon on the upper right of Settings.
When previewing your application, your emulated app will behave as though using whatever Profile is currently selected in Settings.
Every Profile has its own global settings, which define fundamental information regarding how your application will behave.
- Locale - Dictates the default language and timezone of your application. Changes to either can be made by selecting a new language or timezone from the dropdown menus.
- Session Expiration Time - Defines how long a Journey through the app will last before expiring. The maximum session duration is 90 days.
- App Authentication Type - Designates the authentication type that you would designate your app if you were creating an authenticated app experience.
- Delete Profile - Deletes the profile you are working within.
The Base Domain specifies the URL of all links to this application when published under the specified profile.
You will need to add the relevant URL resource to your Organization via the Console in order to have access to it in Settings. For more on how to add these resources to your organization, check out Connecting Your Domain to Airkit.
This section is used to define how your app will make and handle phone calls when deployed. You will need to add the relevant resources to your Organization via the Console in order to have access to them in Settings. For more on how to add phone resources to your Organization, check out Connecting your Twilio Numbers to Airkit.
- Voice Resource - The voice resource (selected from the the voice resources available within your organization) that the application will take and send calls from.
- Voice Locked Behavior - How the application behaves when the voice resource cannot be reached.
- Voice Bot Behavior When Launched - How launching a Voice Bot impacts a user's Journey.
This section is used to define how your app will make and handle text messages when deployed. You will need to add the relevant resources to your Organization via the Console in order to have access to them in Settings. The dropdown menu under SMS Resource will allow you to select from all relevant resources within your organization:
For more on how to add SMS resources to your Organization, check out Connecting your Twilio Numbers to Airkit.
Integrations represent connections to external systems of record. Once your Airkit app is integrated with an external system of record, data can flow easily between them.
Integrations are created through adapters, and you define which Data Source your app uses for each configuration. This can be useful when using different sources of record for production or development.
You will need to add the relevant resources to your Organization via the Console in order to have access to them in Settings. When adding a new integration (by selecting the '+ New' icon on the bottom left), you will only be able to select options from relevant resources within your Organization:
For more on how to integrate external systems of record to your Organization, check out Connecting Airkit to Your Systems.
This section is used to configure email addresses and email domain addresses that can be used to send emails from within Airkit:
You will need to add the relevant resources to your Organization via the Console in order to have access to them in Settings. For more check out Setting up email domains and addresses in Console and Configuring a Domain for Sending Email.
Airkit apps can be associated with their own APIs, to use when you need to interact with your apps or the data within them outside of Airkit. The API Key Filtering section is used to permission your App API based on API Keys:
This section is used to define the web resources that your app will use when deployed. This differs from the web resources defined under Web URLs because these links are associated with individual user Journeys; navigating to a Journey link allows a user to continue an existing Journey, rather than start a new one. (For more on Journey Links, see Linking to Journeys.)
The domain of the Journey Link is specified by the Base Domain section above.
- Journey Link Length - The length the URL path that links to a particular user's Journey; this will be automatically generated so that it is unique for each Journey.
- Expired Session HTML - Defines what a user sees should they try to open a link that leads to an expired Journey.
The web URL is the URL that will launch your app's web experience. This differs from the web resources defined under Journey Links, because the URL defined here will start a new Journey through the application, rather than direct the user to an existing one. (For more on the difference between Starting Links and Journey Links, see Linking to Journeys.)
The domain of the Web URL is specified by the Base Domain section above; URLs without this Base Domain will not be available for selection.
- Name - The name to associate with this launch URL.
- Web Resource - The domain to associate with launching a web component of your application.
This section is used to select the primary Datastore associated with your current Profile. This is where data will be stored to and queried from once your app is deployed.
This section is used to select an encryption key to encrypt designated back-end data. Encryption keys available for selection are configured in the Console under Settings -> Encryption Keys. For more details, see Encrypting Data.
This is a security measure to set valid places to embed Airkit applications. It is possible to specify one or more of these specifications.
- protocol://hostname- Generic way to define any protocol and hostname, for example, "http://airkit.com ."
- https:// - Allows hosting on any secure https connection.
- http:// - Allows embedding on any unsecured http connection.
- file://- Allows for locally hosted files to embed the application.
It can be used with the Airkit webSDK or for directly iframing an Airkit app within a website.
In Studio, go to Settings and scroll down to Target Hostnames. Then enter the URL of the web that will host the app.
Updated 19 days ago