|Release Status||Released||Supported By||Singer community|
|Availability||Free||Status Page||Urban Airship Status Page|
|Default Historical Sync||1 year||Default Replication Frequency||30 minutes|
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
403 Forbiddenerror, 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_airshipin 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 Sync
The Sync Historical Data setting will define the starting date for your Urban Airship integration. This means that data equal to or newer than this date will be replicated to your data warehouse.
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.
Stitch offers two methods of creating a replication schedule:
- Replication Frequency: This method requires selecting the interval you want replication to run for the integration. Start times of replication jobs are based on the start time and duration of the previous job. Refer to the Replication Frequency documentation for more information and examples.
Anchor scheduling: Based on the Replication Frequency, or interval, you select, this method “anchors” the start times of this integration’s replication jobs to a time you select to create a predictable schedule. Anchor scheduling is a combination of the Anchor Time and Replication Frequency settings, which must both be defined to use this method. Additionally, note that:
- A Replication Frequency of at least one hour is required to use anchor scheduling.
- An initial replication job may not begin immediately after saving the integration, depending on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.
To help prevent overages, 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 schemas
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), while case is maintained in PostgreSQL destinations (
CusTomERs). Refer to the Loading Guide for your destination for more info.