This integration is powered by Singer's Urban Airship tap. For support, visit the GitHub repo or join the Singer Slack.
Urban Airship integration summary
Stitch’s Urban Airship integration replicates data using the Airship API version 3. Refer to the Schema section for a list of objects available for replication.
Urban Airship feature snapshot
A high-level look at Stitch's Urban Airship (v1) integration, including release status, useful links, and the features supported in Stitch.
STITCH | |||
Release status |
Released on April 25, 2017 |
Supported by | |
Stitch plan |
Standard |
API availability |
Available |
Singer GitHub repository | |||
REPLICATION SETTINGS | |||
Anchor Scheduling |
Supported |
Advanced Scheduling |
Supported |
Table-level reset |
Unsupported |
Configurable Replication Methods |
Unsupported |
DATA SELECTION | |||
Table selection |
Unsupported |
Column selection |
Unsupported |
Select all |
Unsupported |
||
TRANSPARENCY | |||
Extraction Logs |
Supported |
Loading Reports |
Supported |
Connecting Urban Airship
Urban Airship setup requirements
To set up Urban Airship in Stitch, you need:
-
To verify your Urban Airship API access. Urban Airship limits API access based on their product plans, meaning some plans have access while others do not.
If you create an Urban Airship integration and Stitch displays a
401 Unauthorized
or403 Forbidden
error, you may not have access to Urban Airship’s API.
We recommend reaching out to Urban Airship support to confirm your API access level before beginning the setup in Stitch.
Step 1: Retrieve your Urban Airship app credentials
Connect Multiple Urban Airship Apps
If you want to connect multiple Urban Airship apps to Stitch, you will need to create a separate Urban Airship integration for each app. App credentials are app-specific, meaning only a single app can be connected per Stitch integration.
- Sign into your Urban Airship account.
- In the dashboard, open the app you want to connect to Stitch.
- If the Engage tab doesn’t open, click Engage at the top to open it.
- Click the gear icon located near Reports, then select APIs & Integrations.
- The APIs & Integrations page will display.
Leave this page open for now - you’ll need it to complete the setup.
Step 2: Add Urban Airship as a Stitch data source
- Sign into your Stitch account.
-
On the Stitch Dashboard page, click the Add Integration button.
-
Click the Urban Airship icon.
-
Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.
For example, the name “Stitch Urban Airship” would create a schema called
stitch_urban_airship
in the destination. Note: Schema names cannot be changed after you save the integration. - In the App Key field, paste your Urban Airship App Key.
- In the App Secret field, paste your Urban Airship App Secret.
Step 3: Define the historical replication start date
The Sync Historical Data setting defines the starting date for your Urban Airship integration. This means that:
- For tables using Key-based Incremental Replication, data equal to or newer than this date will be replicated to your destination.
- For tables using Full Table Replication, all data - including records that are older, equal to, or newer than this date - will be replicated to your destination.
Change this setting if you want to replicate data beyond Urban Airship’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.
Step 4: Create a replication schedule
In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.
Urban Airship integrations support the following replication scheduling methods:
-
Advanced Scheduling using Cron (Advanced or Premium plans only)
To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.
Initial and historical replication jobs
After you finish setting up Urban Airship, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.
For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.
Initial replication jobs with Anchor Scheduling
If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.
Free historical data loads
The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.
Urban Airship table reference
Schemas and versioning
Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.
The schema and info displayed below is for version 1 of this integration.
This is the latest version of the Urban Airship integration.
Table and column names in your destination
Depending on your destination, table and column names may not appear as they are outlined below.
For example: Object names are lowercased in Redshift (CusTomERs
> customers
), while case is maintained in PostgreSQL destinations (CusTomERs
> CusTomERs
). Refer to the Loading Guide for your destination for more info.
channels
Replication Method : |
Key-based Incremental |
Replication Key |
created : last_registration |
Primary Key |
channel_id |
API endpoint : |
The channels
table contains info about the channels - or unique identifiers - used to address applications on iOS, Android, and Amazon devices.
channel_id
The channel ID. Reference: |
|||||
created
The date the channel was created. |
|||||
last_registration
The last registration date of the channel, if known. |
|||||
device_type
The platform type of the channel. Possible values:
|
|||||
installed
Indicates if the channel is installed. |
|||||
background
Indicates if the device associated with the channel has background app refresh enabled. |
|||||
opt_in
Indicates if the channel is opted-in to push. |
|||||
push_addresses
The address to send the push. |
|||||
named_user_id
A customer-chosen ID that represents the device user. Reference: |
|||||
alias
The alias associated with the channel. This field has been deprecated by Urban Airship. |
|||||
tags
A list of tags associated with the channel.
channels (table), tags (attribute)
|
|||||
tag_groups
Details about the customer-created tag groups and device property tags associated with the channel.
|
|||||
ios
Details about iOs-specific parameters.
|
Replication Method : |
Key-based Incremental |
Replication Key |
created : last_modified |
Primary Key |
name |
API endpoint : |
The Urban Airship
table contains info about device lists.
name
The name of the list. |
||
created
The time the list was created. |
||
last_modified
The time the list was last updated. |
||
description
A description of the list. |
||
extra
A list of the arbitrary, user-provided JSON values associated with the list.
|
||
channel_count
A count of resolved channels for the last uploaded and successfully processed identifier list. |
||
status
The status of the list. Possible values:
|
named_users
Replication Method : |
Full Table |
Primary Key |
named_user_id |
API endpoint : |
The named_users
table contains info about named users, or individual consumers. These identifiers can be used to map CRM data to channels.
named_user_id
The named user ID. Reference: |
|
tags
The tags applied to the named user.
named_users (table), tags (attribute)
|
|
channels
The channels associated with the named user.
|
segments
Replication Method : |
Key-based Incremental |
Replication Key |
creation_date : modification_date |
Primary Key |
id |
API endpoint : |
The segments
table contains info about segments, or portions of your audience that have arbitrary metadata attached.
id
The segment ID. |
creation_date
The date the segment was created. |
modification_date
The date that the segment was last updated. |
display_name
The display name of the segment. |
Related | Troubleshooting |
Questions? Feedback?
Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.