Salesforce Marketing Cloud

Companies use mobile engagement to deliver positive brand experiences, support their business goals, and build long-term relationships. You can coordinate all your engagement campaigns within the Salesforce Marketing Cloud (SFMC) Journey Builder.

Easily zero-in on the exact mobile insights necessary to drive automated and targeted actions in other systems, through Urban Airship's Journey Builder integration. Additionally, you can send all of your mobile data to SFMC via Urban Airship Connect.

Setup steps for both the AppExchange and Connect integrations are documented here.

Use Cases

Create A Compelling Campaign In Minutes
Initiate campaigns with easy-to-use tools that don’t require a development team. With Urban Airship, you can add mobile and web messaging to any customer journey that will deliver in-the-moment value to your app audience.
Create Automated Journeys Triggered by Cross-Channel Events
Send targeted campaigns to onboard, activate, retain and re-engage your customers. Easily zero in on the exact mobile insights necessary to drive targeted actions in other systems.
Configure Multiple Apps to be Integrated with SFMC
Most companies have multiple apps for various purposes - now you can easily configure them all in this integration and target them in individual campaigns.
Add Actions and Extras to Message Payloads
Do more with your messages by adding Actions (Deep Links, Landing Pages, Tagging, etc.) and Extras (Key/Value pairs available to the app upon direct open).
Track Engagement of Mobile Users
Understand and leverage how and when your users are using (or not using) your app in the Marketing Cloud interface.
Re-engage Mobile Users
Use cross-Channel marketing to re-engage users when they uninstall your app or convert on their mobile device.

Setup: Journey Builder

After completing the Journey Builder setup, learn how to configure activities in Custom Mobile Activity and Custom Web Activity below.

Note

Your Urban Airship account must include Engage at minimum.

Urban Airship: Named User

This integration requires Named Users. Named Users are a system for mapping customer-chosen IDs to anonymous device IDs, supporting integrations with CRMs or other backend databases.

The Named User ID set on a device must map back to a data extension within Salesforce Marketing Cloud. Without this Named User set, Urban Airship will not be able to target a specific device.

See our Named User documentation to set the Named User ID for a device via the iOS SDK, Android SDK, or the server-side API.

SFMC: Install App

Add the Urban Airship Engage app to Salesforce.

  1. Go to the Urban Airship Engage app in the Salesforce AppExchange, and click the Get It Now button. You will be prompted to complete an enrollment form:An Account Manager will contact you to complete the process. You will be notified via email when Salesforce has been added to your account, and the email will include an installation link to add the app to your Marketing Cloud instance.

SFMC: Configure App

Configure the Urban Airship Engage app in the Salesforce Marketing Cloud. You must complete these steps for each Urban Airship project you would like to use with Journey Builder.

  1. Open your instance of Salesforce Marketing Cloud.

  2. Hover over AppExchange in the navigation header, then click Urban Airship from the list that appears.
  3. Click the Add Application + button, then configure the app.
    • App Name: You will likely want to enter the same name as your Urban Airship project.

    • App Key and Master Secret: You can grab these from your Urban Airship project's Settings menu:

      1. Open your project from the dashboard, then click Settings and select APIs & Integrations.

      2. Copy the App Master Secret from the Urban Airship API tab.

    • Named User Data Extension: Click to select the Data Extension that contains a field that maps to Named User, and select that matching field from the Available Fields dropdown menu.

    • Issue Notification Email Address: Enter the email address where you would like to be notified of any issues with sends.
  4. Click the Add Application button, or Cancel to discard.

SFMC: Configure Data

The Data Extension field that matches your Named User must be linked back to the Contact Model. This is done using the SFMC Data Designer.

If you need assistance with this step, contact your SFMC administrator.

Setup: Connect Integration

Note

Requirements

You will need the following SFMC account information in order to complete the SFMC Setup section below:

  1. An API user account username and password. Be sure to give the user the privileges needed to add, edit, and insert data into Data Extensions.

  2. Stack ID. This is in the URL of your SFMC instance:

  3. MID. This appears when you hover over the business unit dropdown menu in the upper-right corner of the SFMC interface:

If these items are not available to you, contact your SFMC admin.


  1. Open your project from the dashboard, then click Settings and select Connect Integrations.

  2. Under the Connections heading, click Salesforce AppExchange.

  3. Configure a new Salesforce AppExchange integration:
    • Enter a user-friendly name and description.
    • Enter SFMC Setup data specified in the note above. If you do not have this information, contact your SFMC admin.
    • Choose one or more event type:

      • Opens
      • Closes
      • Custom Events
      • Screen Viewed
      • Location
      • Region
      • Sends
      • Control
      • Tag Changes
      • First Opens
      • Uninstalls
      • Push Bodies
      • Message Center Read, Delivery, and Delete Events
      • In-App Message Expiration, Resolution, and Display Events
      • Web Notify Session
      • Web Notify Click
  4. Click the Save button.

After a short period of time, Connect will create a directory called "airship" in your Data Extensions root folder. The folder will contain 20 Data Extensions. Only the Data Extensions that correspond to your selected Event Types will be populated. DO NOT EDIT these Data Extensions or you may break your integration.

Custom Mobile Activity

Once the app and Data Extension are configured, Urban Airship Mobile and Web Activities can be used in a Journey. These steps walk you through creating a Mobile Activity.

Open an Activity

  1. Hover over Journey Builder in the navigation header, then click Journey Builder from the list that appears.
  2. Drag the Urban Airship Mobile icon onto the Journey Builder Canvas and position it in the correct point within the Journey. The position of the Activity within the Journey can also be modified after setup.
  3. Click icon for the Urban Airship Activity you just positioned. This will open the Activity details, which is where you can modify details about the campaign.


Notification Setup

  1. Select an app from the dropdown menu, and check the boxes for the types of messages you would like to send within the campaign.
  2. Optionally enter a Campaign Category. Click the + (plus sign) icon to add an additional category field, 8 categories maximum. To delete a category, click the trash can icon at the end of its row.

  3. Click the Next button to move on.

Push

If Push was not selected in the Notification Setup step, you will automatically skip to the next step.

  1. Enter the text that will display in your message.
    Note

    Push notifications can be personalized similarly to Marketing Cloud email campaigns. To use personalization data, refer to fields in the Contacts model. These references use the AMPScript syntax, e.g., %%your field name%%, which will find the first field in your contact model that matches that field name and use its value for the contact's personalization.

    If you have multiple fields in the model with the same name, you should also reference the data extension name to ensure you use the intended field, using the format %%data_extension_name.field_name%%.

  2. Click the Next button to move on.

In-App

If In-App was not selected in the Notification Setup step, you will automatically skip to the next step.

  1. Enter the text that will display in your message. If you also included the Push message type, you may optionally check the box to Copy from Push.
    Note

    In-app messages may be personalized. See note in the Push step above.

  2. Click the Next button to move on.

Action

  1. Select a Message Action from the dropdown menu.
  2. Click the Next button to move on.

Extras/Tags

Optionally set Custom Keys or define Tag behavior.

Custom Keys, also known as key/value pairs, allow you to pass extra data through your Push Notification payload for use by custom code in your app. Common uses of custom keys include passing additional campaign identifiers for analytics, passing user profile information to the device, controlling the look and feel of the app, providing image links, etc.

By default, a custom key is sent to Push Notifications on all platforms, but you can choose platform-specific keys as well if your message is going out to more than one platform, e.g., one imageURL for iOS and another imageURL for Android.

  1. Enter the key name and value, then click the + (plus sign) icon. To delete a custom key, click the trash can icon at the end of its row.
  2. Select Add Tag or Remove Tag from the dropdown menu, enter the tag value, then click the + (plus sign) icon. To delete a tag, click the trash can icon at the end of its row.

  3. Click the Next button to move on.

Confirmation

  1. Review the message summary.
    If you would like to make changes, click the Back button to return to a previous step, make your changes, then click Next to return to the Confirmation step.

  2. Click the Done button to save the Activity.

Be sure to complete the remaining Journey Builder configuration steps.

Custom Web Activity

Once the app and Data Extension are configured, Urban Airship Mobile and Web Activities can be used in a Journey. These steps walk you through creating a Web Activity.

Open an Activity

  1. Hover over Journey Builder in the navigation header, then click Journey Builder from the list that appears.
  2. Drag the Urban Airship Web icon onto the Journey Builder Canvas and position it in the correct point within the Journey. The position of the Activity within the Journey can also be modified after setup.
  3. Click icon for the Urban Airship Activity you just positioned. This will open the Activity details, which is where you can modify details about the campaign.


Notification Setup

  1. Select an app from the dropdown menu.
  2. Optionally enter a Campaign Category. Click the + (plus sign) icon to add an additional category field, 8 categories maximum. To delete a category, click the trash can icon at the end of its row.

  3. Click the Next button to move on.

Web

  1. Define what will display in your web push notification.
    • Browser message: The body of the message.
    • Title: The text that appears above the message body.
    • Icon URL: Overrides the icon set in Settings » Platforms » Web Notify. Optional. HTTPS is required.
      Note

      Web push notifications can be personalized similarly to Marketing Cloud email campaigns. To use personalization data, refer to fields in the Contacts model. These references use the AMPScript syntax, e.g., %%your field name%%, which will find the first field in your contact model that matches that field name and use its value for the contact's personalization.

      If you have multiple fields in the model with the same name, you should also reference the data extension name to ensure you use the intended field, using the format %%data_extension_name.field_name%%.

  2. Click the Next button to move on.

Action

  1. Select a Message Action from the dropdown menu.
  2. Click the Next button to move on.

Extras

Optionally set Custom Keys.

Custom Keys, also known as key/value pairs, allow you to pass extra data through your Push Notification payload for use by custom code in your app. Common uses of custom keys include passing additional campaign identifiers for analytics, passing user profile information to the device, controlling the look and feel of the app, providing image links, etc.

  1. Enter the key name and value, then click the + (plus sign) icon. To delete a custom key, click the trash can icon at the end of its row.
  2. Click the Next button to move on.

Confirmation

  1. Review the message summary.
    If you would like to make changes, click the Back button to return to a previous step, make your changes, then click Next to return to the Confirmation step.

  2. Click the Done button to save the Activity.

Be sure to complete the remaining Journey Builder configuration steps.