Release Status Released Availability Free
Status Page Urban Airship Status Page Default Historical Sync 1 year
Whitelist Tables/Columns Unsupported/Unsupported Default Replication Frequency 30 minutes
Full Table Endpoints 1 Incremental Endpoints 3
Destination Incompatibilities None

Connecting Urban Airship

Connecting Stitch to Urban Airship is a four-step process:

  1. Retrieve your Urban Airship app credentials
  2. Add Urban Airship as a Stitch data source
  3. Define the Historical Sync
  4. Define the Replication Frequency

Prerequisites

Before you begin the setup process, 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:

  • Enterprise, Essential, Comprehensive: If you’re using one of these Urban Airship plans, API access should be enabled by default.
  • Starter, Basic: These Urban Airship plans do not have API access. To use Stitch’s integration, you’ll need to upgrade your Urban Airship plan to a level that includes API access.

    Note completing the integration setup process in Stitch using one of these Urban Airship plans will result in 401 permission errors.

Retrieve Your Urban Airship App Credentials

  1. Sign into your Urban Airship account.
  2. In the dashboard, open the app you want to connect to Stitch.
  3. If the Engage tab doesn’t open, click Engage at the top to open it.
  4. Click the gear icon located near Reports, then select APIs & Integrations.
  5. The APIs & Integrations page will display.

Leave this page open for now - you’ll need it to complete the setup.

Add Urban Airship as a Stitch Data Source

  1. On the Stitch Dashboard page, click the Add an Integration button.
  2. Click the Urban Airship icon.

  3. Enter a name for the integration. This is the name that will display on the for the integration; it’ll also be used to create the schema in your data warehouse.

    For example, the name “Stitch Urban Airship” would create a schema called stitch_urban_airship in the data warehouse. This schema is where all the tables for this integration will be stored.

  4. In the App Key field, paste your Urban Airship App Key.
  5. In the App Secret field, paste your Urban Airship App Secret.

Define the Historical Sync

The Sync Historical Data setting will define the starting date for your Urban Airship integration. This means that:

  • For tables using Incremental Replication, data equal to or newer than this date will be replicated to your data warehouse.
  • 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 data warehouse.

Change this setting if you want to sync data beyond Urban Airship’s default setting of 1 year. For a detailed look at historical syncs, check out the Syncing Historical SaaS Data article.

Define the Replication Frequency

The Replication Frequency controls how often Stitch will attempt to replicate data from your Urban Airship integration. By default the frequency is set to 30 minutes, but you can change it to better suit your needs.

Before setting the Replication Frequency, note that the more often Urban Airship is set to replicate, the higher the number of replicated rows.

Additionally, the number of rows Stitch replicates is impacted by:

  • The Replication Methods used by this integration’s tables. Refer to the Schema section for info on how specifc tables are replicated.

To help prevent overages, we recommend setting the integration to replicate less frequently. For example: every 6 hours instead of every 30 minutes.

After selecting a Replication Frequency, click Save Integration.

Urban Airship’s Intial Sync

After you finish setting up Urban Airship, you might see its Sync Status 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 sync for the integration. This may take some time to complete.


Urban Airship Schema

Stitch's Urban Airship integration includes these tables:


channels

Replication Method: Incremental
Primary Key: channel_id
Contains Nested Structures?: Yes

The channels table contains info about the channels - or unique identifiers - used to address applications on iOS, Android, and Amazon devices.

Table Info & Attributes

channels & Nested Structures

This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.

These items are marked with a *

channels Attributes

While we try to include everything Urban Airship has here, this may not be a full list of attributes. Refer to Urban Airship's documentation for a full list and description of each attribute.

  • channel_id

  • device_type

  • installed

  • background

  • opt_in

  • push_addresses

  • created

  • last_registration

  • named_user_id

  • alias

  • tags*

  • tag_groups*

  • ios__badge

  • ios__quiettime__start

  • ios__quiettime__end

  • ios__tz

lists

Replication Method: Incremental
Primary Key: name
Contains Nested Structures?: No

The lists table contains info about device lists.

Table Info & Attributes

lists Attributes

While we try to include everything Urban Airship has here, this may not be a full list of attributes. Refer to Urban Airship's documentation for a full list and description of each attribute.

  • name

  • description

  • extra*

  • created

  • last_modified

  • channel_count

  • status

named_users

Replication Method: Full Table
Primary Key: named_user_id
Contains Nested Structures?: No

The named_users table contains info about named users, or individual consumers. These identifiers can be used to map CRM data to channels.

Table Info & Attributes

named_users Attributes

While we try to include everything Urban Airship has here, this may not be a full list of attributes. Refer to Urban Airship's documentation for a full list and description of each attribute.

  • named_user_id

  • tags*

  • channels*

segments

Replication Method: Incremental
Primary Key: id
Contains Nested Structures?: Yes

The segments table contains info about segments, or portions of your audience that have arbitrary metadata attached.

Table Info & Attributes

segments & Nested Structures

This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.

These items are marked with a *

segments Attributes

While we try to include everything Urban Airship has here, this may not be a full list of attributes. Refer to Urban Airship's documentation for a full list and description of each attribute.

  • Segment ID (id)

  • display_name

  • creation_date

  • modification_date



Questions? Feedback?

Did this article help? If you have questions or feedback, please reach out to us.