The Settings section of the dashboard is where you control your app’s configuration, integrations, permissions, and more.
Choose your app from the Urban Airship dashboard, click the gear icon (Settings) dropdown menu, and make your selection. Each section’s purpose and options are detailed below.
The Quickstart Guide walks you through the technical steps you need to perform in order to send your first push notification.
Documentation for implementing the Urban Airship SDK, connecting to push notification services, e.g., APNs and GCM, and configuring your project for push notifications is provided from within the guide.
App Details is where you can change your app’s name, set its icon, and select its mobile platforms.
- Enter your app’s display name.
- Optionally choose or change the app icon.
- Click to select or remove the platforms that will use Urban Airship. Selected platforms are highlighted blue.
- Click the Save button, or click cancel to discard your changes. Clicking cancel will return you to the app dashboard.
Delete your app by clicking delete this app in the lower right corner.
Team Access is where you can view and manage app-related responsibilities.
When you register on go.urbanairship.com, two linked accounts are created:
- Company Account
- Where apps are created and contained.
- Controlled by a single User Account.
- User Account
- The Owner of the Company Account.
Only the Owner of a Company Account can create apps for that company.
- Access is set for each app individually.
- User Accounts that have an assigned role for a particular app are members of that app’s Team.
- When an Owner creates an app, the Owner is automatically its first Team member.
- A User Account can only be an Owner of one company but may be a Team member of multiple apps.
App Team members will only see the app functions that apply to their role(s). For example:
- If you’re assigned to Composers Only, you will see in the app dashboard:
- The Create New button
- The Messages menu
- If you’re assigned to Reports and Composers, you will see in the app dashboard:
- If you’re assigned to Reports Only, you will see in the app dashboard:
Users cannot create apps in Company Accounts they do not own. If you need a new app to be created in a Company Account that you are not the Owner of, the Owner of that Company must first create the app, then invite you to the new app’s Team.
|Tasks by Individual App||Owner||Administrator||Full Access||Reports Only||Composers Only||Reports & Composers||Reports, Composers, Segments|
|Create an app||X|
|Delete an app||X|
|View App Key, Secret, and Master Secret||X||X||X|
|Create Message Personalization Templates||X||X||X|
|Modify App Details||X||X||X|
|Create and modify an IP Whitelist||X|
|Send a Team Access invitation to a new individual||X||X|
|Change an existing Team Member’s app role||X||X|
|Remove a Team Member’s access to an app||X||X|
|Compose Messages, Automated Messages, and A/B Tests||X||X||X||X||X||X|
|View, print, and export Reports||X||X||X||X||X||X|
|View, create, and modify Segments||X||X||X||X|
Sending Team Access Invitations¶
Click in the field Give Access to this App, and it will expand.
Enter the email address or username of the user you want to invite.
If the user has an existing Urban Airship account, enter the user’s Urban Airship username. Otherwise, enter the user’s email address. In either case, the user will receive an email with an invitation to accept the new access. See Accepting Team Access Invitations.
Usernames are case-sensitive. Always use the username, if available. If you enter an email address for an existing Urban Airship user and that user’s account is associated with a different email address than the one you are inviting, he or she may attempt to create a new account.
Select the Access Level from the dropdown menu. See Role Responsibilities for detail.
If you entered a username or email address matching an existing Urban Airship user, when you click the Access Level menu, a banner appears below the menu, alerting you that the user “already has a role on this app!”
Choose whether to send the invitation from Urban Airship or [Your] email address.
- My email address
This is the best option, as the invitation will appear as being sent directly from you, and you will receive any bounce notifications in the case the email address is invalid. The invitation is also less likely to be caught in the recipient’s spam filter.
- Send from Urban Airship
Some companies’ email servers enforce a rule requiring domain name and email sender fields to be the same. If this is true for your company, choose this option to ensure that your email goes through. However, you may also want to ask the recipient to look for this email and also check any spam filter for it.
Optionally Add a personal note.
Optionally check the box to Send a copy to yourself.
Click the Give Access button, or click cancel to discard.
The new user will be listed in the Team Access list by username if an account already exists, or by email address if an account still needs to be created. Users with pending invitations have (pending) noted next to the username or email address.
When a user either accepts an invitation or creates an Urban Airship account, the (pending) designation no longer appears next to the username in the Team Access list.
If a user with an existing Urban Airship account declines an invitation, the user will be removed from the app’s Team Access list.
A user without an Urban Airship account will remain on the Team Access list as (pending) until access is accepted, or until manually removed.
Accepting Team Access Invitations¶
Users who do not yet have an Urban Airship account will receive email with subject Activate your Urban Airship account and a request to follow a link to confirm the email address and activate the account. Saving the password activates the account.
All users will receive an email to accept the app access at go.urbanairship.com/companies/pending_shares. If already logged in, this is accessible by clicking your username in the upper right corner, then selecting Team Access from the dropdown menu.
Accept or decline an invitation by clicking the appropriate button.
If an invitation is declined, the notice is permanently deleted. A user cannot revert this decision and accept at a later time. A new invitation must be sent by the app Owner or Administrator.
After accepting an invitation, the notification is removed from the Accept Access list.
Changing App Roles¶
Services is where you add, manage, and remove the third-party messaging platforms you have configured for your app, e.g., APNS.
For information about configuring new services, see the Getting Started documentation.
To manage or remove existing services, click the Edit button at the end of its row. Configuration fields vary per service. If you have APNS configured, its expiration date will display, and you have the option to upload a new certificate.
Click the Save button, or cancel to discard.
To remove the service from your app, click remove this service.
If your account has been enabled for Apple News Push Notifications, configure it here. See the Apple News composer for usage information.
Click the Configure button. The button is labeled Edit if already configured.
Enter values for each field, and check the box for each of the Supported Countries you have configured in your Apple News publisher channel settings.
- Channel Name: Your Apple News channel name. This is used for preview purposes in the composer.
- Channel ID: Your Apple News channel ID.
- API Key: Your Apple News API key.
- API Secret: Your Apple News API secret.
- Your Apple News channel ID has no relation to an Urban Airship Channel ID.
- We validate the country selection when the Send Now or Send When Live button is clicked as the final step in composing an Apple News message. If a country selected here is not configured in your Apple News publisher channel settings, you will see an error in the composer when attempting to send to that country.
Click the Save button, or cancel to discard.
To remove the service from your app, click remove this service.
Configuration is where you control the features and settings related to composing and sending messages. Four tabs organize the settings for Deep Links, Notification Buttons, In-App Messages, and Automation Limits. See the composers for reference:
Each feature is listed with a description and its minimum SDK version. Toggle to enable/disable.
The On/Off feature controls only apply to functionality within the message composers. They do not enable or disable functionality at the API level.
- Message Center: Deliver rich content to a message center in your app. SDK 2.0+
- Delivery by Time Zone: Schedule a message to go out at the same time in different time zones. SDK 3.1+
- Landing Page, Deep Link, URL, and Add Tags: UA Actions Framework. SDK 4.0+
- Remove Tags: Remove a tag when a user interacts with a push notification or button. SDK 4.0+
- Notification Buttons: Interactive notifications for your app, including our 30+ out-of-the-box buttons. SDK 5.0+
- In-App Messages: Send a message that appears inside your app. SDK 6.0+
- Custom Keys: Pass key/value pairs of custom data through the push to your app. All SDKs.
- Broadcast Push: Option to send to all app users. All SDKs.
Some newer Notification Buttons require a later SDK. See Built-In Interactive Notification Types for the full list and SDK requirements.
A description of each Predictive type is below. Toggle to enable.
- Churn: Analyze your app’s audience to identify user devices that exhibit behaviors indicating they are likely to become inactive. You must have at least one week of churn analysis before you can target churn risk groups. See the Predictive Churn topic guide for usage information.
In-App Messages are banner notifications that appear inside of your app. Configure their appearance.
Enter the hex values for the Primary and Secondary Colors. Primary is the message backgrouns. Secondary is the message text.
Choose whether the In-App Message will appear at the Top or Bottom of the screen.
Set the Duration of time that the In-App message displays on the screen. Default is 15 seconds, or select Specify and enter a value for the number of Seconds or Minutes.
Click the Save button.
Automation Limits control over-notification to users who repeatedly meet Automation Composer criteria, capping automated messages per device per given time interval, e.g., a maximum of 4 messages every 10 hours. Add, edit, and delete Automation Limits here.
Click the + Add Limit button.
Enter the maximum number of messages to be sent within the time period, then define the time period with a number of Hours or Days, no more than 48 hours or 90 Days.
To add another, click the +Add Limit button and continue with your specifications. Two limits are the maximum.
Click the Save button.
Edit the limits at any time. Delete a limit by clicking the X at the end of its row.
Automation Limits occur at the app level. You can also create a Rule Limit for a specific message. For example, if you create an Automated Message with a trigger that is likely to occur frequently, a Rule Limit would prevent the repeated delivery of the same message to the user. See Automation Set Up options.
Automation Limits indicators are in multiple locations.
Automation Composer: The last option in Automation Composer Set Up.
Messages Overview: The bottom right corner of the Messages » Messages Overview » Automated tab.
Message Report: The top right corner of an Automated message’s Message Report.
APIs and Integrations¶
Your API & Integrations information, options, and settings are organized in three tabs: Urban Airship API, Integration Options, and Gimbal.
Urban Airship API¶
View your app’s App Key, App Secret, App Master Secret, and Configuration Details. For more information, see App Keys & Secrets: Security.
Configure the Mobile Data Bridge for Named Users and Tag Groups. See the Mobile Data Bridge Primer for requirements and usage information.
Before enabling client-side association, consider your use case. By restricting association to server-side calls only, you have the added security of requiring your master secret to be verified after each call. While this creates a more secure call to association, you also lose the convenience of having your application automatically associate named users on login. Most apps will not require this additional security, but if your app deals with extremely sensitive data, you may want to consider leaving this disabled and doing named user association exclusively through the API.
Tag Groups are configurable namespaces for organizing tags. Primary Device Tags is a predefined Tag Group, and you may create up to five custom Tag Groups. See Tag Groups Walkthrough for usage information.
Existing tags associated with your mobile audience are listed under Primary Device Tags. In most cases this means all the tags that are currently being set via the Urban Airship SDK based on users’ interaction with the app. For example, if you send a push that sets a tag on a user after they tap it, then that tag is added to the Primary Device Tags group.
Create a Tag Group¶
Tag Groups cannot be deleted, and the Group Key field and security setting cannot be edited. Please double check that the Group Key is correctly filled out and the security setting is appropriate.
Click the + Tag Group button.
Enter a Name, Description, and Group Key for the new tag group.
- Name: This Name appears elsewhere in the UI, so choose something easily understandable that directly links back to the associated database, e.g., “Loyalty Database Tags.”
- Description: The Description should supplement the title, giving additional information about the Tag Group, if necessary. Be descriptive enough that anyone in your company would understand its source and purpose.
- Group Key: This permanent, unique ID is the text you will use when referring to your Tag Group in the API. While you can use any characters for the Group Key, it is highly recommended that you exclusively use lowercase ASCII characters. No spaces are allowed in a group key. Example: pos-database.
Urban Airship reserves Tag Groups prefixed with "ua_". Any Tag Groups you might create with that prefix will not function.
Optionally enable high security for read-write operations, only allowing tags be read or changed by API calls authenticated with your master secret key. Check the box to Allow these tags to be set only from your server.
Without this Security setting enabled, tags can be read and written from an app using only the application secret. By enabling the high security setting, read-write operations must be validated with your master secret key, preventing attackers from using the app secret to set or read their own device tags. Whether or not your app will benefit from this added security depends on the use case. If preventing attackers from reading or setting their own device tags is absolutely critical, consider enabling this feature.
Click the Save button, or Cancel to discard.
Edit a Tag Group¶
Your custom Tag Groups are listed below the Primary Device Tags box. Click the Edit button to make changes.
Only Name and Description are editable fields. You may also check/uncheck the box to Enable this Tag Group. Click the Save button, or Cancel to discard.
When sending an Automated message, you may choose to trigger sending the message based on Location. Location Triggers require integration with the Gimbal Platform. See Location Triggers for requirements and set up information.
If you have already configured Gimbal, you have two options.
Sync location data from Gimbal: Click the Sync Now button.
Delete your current Gimbal Server API key: Click remove this API Key. A warning displays with confirmation steps. Check the box for I would like to proceed and click the Yes, remove button, or click the Nevermind button to cancel.
The Test Push form is a simple utility for testing push notifications without needing to format HTTP requests using a Command-line tool such as cURL. One tab is displayed per platform. Platforms are configured in Settings » Services.
The Test Push form supports sending test notifications to iOS, Android, Windows Phone 8 and Windows 8. Amazon is not supported, and no new delivery platforms will be added to this legacy utility in the future.
Select a tab, fill out the fields, then click the Send it! button. Fields per platform are listed below.
- Channel ID or Device Token: Specify the device you are sending the test push to by entering a Channel ID or device token.
- Badge: Enter a badge value to indicate an unread count. Alternatively, you may use the autobadge feature.
- Alert: Enter the text to be displayed in the alert view.
- Sound: Specify a custom sound for the alert. A Core Audio Format (CAF) file must be present in the application build in order to play the sound. If no custom sound is provided, the default sound will play.
- Payload: Use JSON to specify the notification payload. It is not necessary to enter the JSON directly into this field; the field will automatically populate based on the values given in the fields above.