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
Whitelisting Unsupported Destination Incompatibilities None

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 or 403 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

  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.

Step 2: Add Urban Airship as a Stitch Data Source

  1. On the Stitch Dashboard page, click the Add 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 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.

  4. In the App Key field, paste your Urban Airship App Key.
  5. 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:

  • 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 guide.

Step 4: Define Replication Frequency

The Replication Frequency controls how often Stitch will attempt to extract data from your Urban Airship integration.

Note: This setting only affects the frequency of data extraction from Urban Airship, not the interval at which data is loaded into your data warehouse. For example: a one (1) minute Replication Frequency means Stitch will attempt to extract data every minute, but loading the extracted data may take longer than this.

Use the Default Frequency

To use the default Replication Frequency (30 minutes), leave the Use integration default box checked and click Check and Save to create the integration.

Customize the Frequency

To adjust the Replication Frequency:

  1. Uncheck the Use integration default checkbox. A slider with various frequencies will display.
  2. Click the desired frequency on the slider.
  3. Click Check and Save to create the integration.

To help prevent overages, consider setting the integration to replicate less frequently. See the Understanding & Reducing Your Row Usage guide for tips on reducing your usage.

Urban Airship’s Intial Replication Job

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 replication job for the integration. This may take some time to complete.


Urban Airship Table Schemas

Replication Method: Incremental Replication Key : created : last_registration
Primary Key : channel_id API Endpoint: channelListing

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

channel_id
INTEGER

The channel ID.

created
DATE-TIME

The date the channel was created.

last_registration
DATE-TIME

The last registration date of the channel, if known.

device_type
STRING

The platform type of the channel. Possible values:

  • ios
  • android
  • amazon
  • web
installed
BOOLEAN

Indicates if the channel is installed.

background
BOOLEAN

Indicates if the device associated with the channel has background app refresh enabled.

opt_in
BOOLEAN

Indicates if the channel is opted-in to push.

push_addresses
STRING

The address to send the push.

named_user_id
STRING

A customer-chosen ID that represents the device user.

alias
STRING

The alias associated with the channel. This field has been deprecated by Urban Airship.

tags

A list of tags associated with the channel.

This data may be de-nested into a subtable if your data warehouse doesn't natively support nested data.

This subtable would be named channels__tags and may contain the following attributes:

_sdc_source_key_channel_id
INTEGER

The channel ID.

_sdc_level_0_id
INTEGER

This column forms part of a composite key for the table. The value will auto-increment for each unique record, beginning with 0.

value
STRING

The tag associated with the channel.

tag_groups

Details about the customer-created tag groups and device property tags associated with the channel.

This data may be de-nested into a subtable if your data warehouse doesn't natively support nested data.

This subtable would be named channels__tag_groups and may contain the following attributes:

_sdc_source_key_channel_id
INTEGER

The channel ID.

_sdc_level_0_id
INTEGER

This column forms part of a composite key for the table. The value will auto-increment for each unique record, beginning with 0.

name
STRING

The name of the tag group.

tags

Details about the tags associated with the tag group.

This data may be de-nested into a subtable if your data warehouse doesn't natively support nested data. See the Singer schema for detail on possible attributes.

ios__badge
STRING

The current badge value.

ios__quiettime__start
STRING

The start of quiet time.

ios__quiettime__end
STRING

The end of quiet time.

ios__tz
STRING

The timezone associated with the iOS device.


Replication Method: Incremental Replication Key : created : last_modified
Primary Key : name API Endpoint: allLists

The lists table contains info about device lists.

name
STRING

The name of the list.

created
DATE-TIME

The time the list was created.

last_modified
DATE-TIME

The time the list was last updated.

description
STRING

A description of the list.

extra

A list of the arbitrary, user-provided JSON values associated with the list.

This data may be de-nested into a subtable if your data warehouse doesn't natively support nested data.

This subtable would be named lists__extra and may contain the following attributes:

_sdc_source_key_name
STRING

The name of the list.

_sdc_level_0_id
INTEGER

This column forms part of a composite key for the table. The value will auto-increment for each unique record, beginning with 0.

key
STRING

The key to the associated value.

value
STRING

The value associated with the given key.

channel_count
INTEGER

A count of resolved channels for the last uploaded and successfully processed identifier list.

status
STRING

The status of the list. Possible values:

  • ready
  • processing
  • failure : > * ready - Indicates the list was processed successfully and is ready for sending.

Replication Method: Full Table API Endpoint: namedUsersListing
Primary Key : named_user_id

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
STRING

The named user ID.

tags

The tags applied to the named user.

This data may be de-nested into a subtable if your data warehouse doesn't natively support nested data.

This subtable would be named named_users__tags and may contain the following attributes:

_sdc_source_key_named_user_id
STRING

The named user ID.

_sdc_level_0_id
INTEGER

This column forms part of a composite key for the table. The value will auto-increment for each unique record, beginning with 0.

value
STRING

The tag applied to the named user.

channels

The channels associated with the named user.

This data may be de-nested into a subtable if your data warehouse doesn't natively support nested data.

This subtable would be named named_users__channels and may contain the following attributes:

_sdc_source_key_named_user_id
STRING

The named user ID.

_sdc_level_0_id
INTEGER

This column forms part of a composite key for the table. The value will auto-increment for each unique record, beginning with 0.

value
STRING

The ID of the channel associated with the named user.


segments

Replication Method: Incremental Replication Key : creation_date : modification_date
Primary Key : id API Endpoint: segmentListing

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

id
STRING

The segment ID.

creation_date
DATE-TIME

The date the segment was created.

modification_date
DATE-TIME

The date that the segment was last updated.

display_name
STRING

The display name of the segment.



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.