Airship Push Connector Setup Guide

[#1]

This article describes how to set up the Airship Push connector in your Customer Data Hub account.

In this article:

Table of Contents Placeholder

Connector Actions

Action Name	AudienceStream	EventStream
Send a Push Notification Based on Named User Identifier	✓	✗
Send Push Notification Based on Channel ID	✓	✗
Send an Email Notification Based on Named User Identifier	✓	✗

Configure Settings

Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector.

After adding the connector, configure the following settings:

• App Key
  • Basic master auth is required for push endpoints.
  • For more information, see Airship Authentication.
• Master Secret
  • Basic master auth is required for push endpoints.
  • For more information, see Airship Authentication.

Action Settings - Parameters and Options

Click Next or go to the Actions tab. This is where you configure connector actions.

This section describes how to set up parameters and options for each action.

Action - Send a Push Notification Based on Named User Identifier

Parameters

Parameter	Description
Named User	A named_user is an alternate name mapped to a user profile in a different database, such as CRM, that can be used to target devices associated with that profile. For more information on named users, see: Named Users.
Notification Message	A notification message, displayed for any platforms receiving the push. For more information on this endpoint, see: Airship Push/Post.

Action - Send Push Notification Based on Channel ID

Parameters

Parameter	Description
Channel ID	The Channel ID for the device you wish to send a push message to. For more information on Channel ID's, see: Airship Intro to Channels.
Notification Message	A notification message, displayed for any platforms receiving the push. For more information on this endpoint, see: Airship Push/Post.

Action - Send an Email Notification Based on Named User Identifier

Parameters

Parameter	Description
Named User	A named_user is an alternate name mapped to a user profile in a different database, such as CRM, that can be used to target devices associated with that profile. For more information on named users, see: Named Users.
Message Type	Must be transactional or commercial. For more information on this endpoint, see: Airship Email Override.
Plain Text Body	The plain text body of the email you want to send, no larger than 100kb. For message_type:commercial, the body must contain a [[ua_unsubscribe]] link, which will be replaced by the unsubscribe link in Airship. You can send the user to a custom "goodbye" page by providing an href in the following format: [[ua-unsubscribe href="your url here"]]. If you include an href , Airship unsubscribes the user before redirecting to your page.
Reply To	String. Required. The reply-to address.
Sender Address	The email address of the sender. The domain of the email must be enabled in the email provider at the delivery tier/ Example: Sparkpost
Sender Name	The common name for the sender, visible to email recipients.
Subject	The subject line of the email.
Bypass Opt In Level	You can set this when message_type is set to transactional to send a business critical email. If set to true, the message is sent to your entire audience, ignoring the transactional_opted_out status.
HTML Body	The rich-text html body of the email, no larger than 100kb. For message_type:commercial, the body must contain an unsubscribe link in the Unsubscribe format. You can send the user to a custom "goodbye" page by providing an href attribute in the link: Unsubscribe. If your unsubscribe link includes an href, Airship unsubscribes the user before redirecting to your page.