mParticle Integration

Appboy is dedicated to creating partner integrations that allow you to send data from multiple sources to your Dashboard. mParticle is an analytics data hub that allows you to track your users and route that data to a wide variety of user analytics providers, such as Appboy. mParticle has a basic core integration which only allows access to our push notification and segmentation, as well as an embedded SDK option which ensures your ability to take advantage of in-app messages, the news-feed and feedback as well.

Getting Started

Appboy recommends using the embedded SDK flavor of the mParticle/Appboy integration as push notifications alone don’t form a complete mobile marketing strategy. You can enable the additional functionality by following their Appboy specific documentation.

Enabling Push Notifications

Push Notifications via mParticle and Appboy must be enabled through the integration steps included in this section of the mParticle documentation.

Enabling Location Tracking

Location Tracking via mParticle and Appboy must be enabled through the integration steps included in this section of the mParticle documentation.

News Feed Customization & Integration

In addition to using the embedded SDK, you must also integrate the news-feed directly into your application as it functions as a rich message inbox for users that updates in real time based upon the segments they’re a member of. For directions on integrating the news-feed, see our iOS and Android documentation.

Segment Integration

Appboy is dedicated to creating partner integrations that allow you to send data from multiple sources to your Dashboard. Segment is an analytics data hub that allows you to track your users and route that data to a wide variety of user analytics providers, such as Appboy. We offer both a server-to-server integration and a side-by-side SDK integration so that you can start building richer user profiles.

Side-by-Side SDK Integration

Appboy’s side-by-side integration maps Segment’s SDK to ours, allowing access to deeper features and a more comprehensive usage of Appboy than the server-to-server integration. These mappings of Segment’s SDK for both Android and iOS are open source and can be found on our GitHub page.

To complete the side-by-side integration, please refer to Segment’s detailed instructions for Android and iOS. For more details regarding Appboy’s SDKs, please refer to our iOS and Android documentation.

Server-to-Server Integration

The server-to-server integration forwards data from Segment to Appboy’s REST API. This function is automatically enabled by setting the App Group Identifier in the Appboy Settings in Segment. Unlike the side-by-side integration, however, the server-to-server integration does not support any of Appboy’s UI features, such as in-app messaging, News Feed, Feedback or push notifications.

Getting Started

Once the Segment library is integrated with your server, toggle Appboy on in your Segment integrations and add your App Group Identifier which you can find in the Appboy Dashboard in your Developer Console.

Appboy supports the identify, track, and group methods.

Identify

When you identify a user, we will record information for that user with userId as the External User ID. Segment’s special traits recognized as Appboy’s standard user profile fields (in parentheses) are firstName (first_name), lastName (last_name), birthday (dob), avatar (image_url), address.city (home_city), address.country (country), and gender (gender). All other traits will be recorded as custom attributes.

Track

When you track an event, we will record that event as a custom event using the name provided.

Completed Order

When you track an event with the name Completed Order using the format described in Segment’s ECommerce API, we will record the products you’ve listed as purchases.

Group

When you call group, we will record a custom attribute with the name ab_segment_group_<groupId>, where groupId is the group’s ID in the method’s parameters. For example, if the group’s ID is 1234, then the custom attribute name will be ab_segment_group_1234. The value of the custom attribute will be set to true.

Enabling Push Notifications

Currently, Appboy’s server-to-server integration with Segment does not support methods for push tokens. In order to enable push notifications in Appboy, you must import push tokens via the User Attribute Object of our User Data REST API.

How To Tell If You’re Receiving Data From Segment

Some automatically captured data is only available through the side-by-side integration. The following data is not available via the server-to-server integration:

  • Sessions
  • First Used App
  • Last Used App

Consequently, most of your app usage dashboard (lifetime sessions, MAU, DAU, Stickiness, Daily Sessions and Daily Sessions per MAU) will be blank even if Appboy is receiving data from Segment.

You can view your data in the custom event dashboard, the revenue dashboard or by creating a segment.

The custom event dashboard allows you to view custom event counts over time. Note that you will not be able to use formulas that include MAU and DAU statistics.

Custom_Events_Segment

If you’re sending purchase data to Appboy (see Completed Order), the revenue dashboard allows you to view data on revenue or purchases over specific periods of time or your app’s total revenue.

Creating a segment allows you to filter your users based on custom event data and custom attribute data. Note that filters related to automatically collected session data (such as “first used app” and “last used app”) will not work.

Attribution Integration

Attribution Overview

Appboy supports integrations with several partners that track the users you acquire through paid advertising campaigns. These integrations make it possible to segment your users by acquistion channel and even by specific paid advertising campaigns. This is useful for determining the real value of users from a given acquisition channel by measuring their engagement throughout the customer lifecycle.

Available Partners

Partner iOS Support? Android Support? Windows Support?
adjust Yes Yes No
appsflyer Yes Yes Yes
apsalar Yes No No
branch Yes No No
kochava Yes No No
tune Yes Yes Yes

Don’t see your attribution service listed here? We might be able to add them! Contact your Customer Success manager and let us know who you’re working with.

Available Segment Filters

  • Attributed Source
  • Attributed Campaign
  • Attributed Adgroup
  • Attributed Ad

Facebook and Twitter Attribution Data

Please note that attribution data for Twitter and Facebook campaigns is not available through our partners. Facebook and Twitter do not permit their partners to share attribution data with third-parties and, therefore, our partners cannot send that data to Appboy.

API Restrictions

Appboy’s attribution integrations (except Adjust) are built on top of our REST API and subject to the same limits. In particular:

  • Access for enterprise customers is unlimited, but subject to contract terms.
  • Access for non-enterprise customers is limited to 100 requests (i.e. up to 100 attributed installs) per hour.
  • If you have questions about these limits, please contact your Customer Success manager.

Integration Instructions by Partner

Adjust

Step 1: Integration Requirements

  • This integration supports iOS and Android apps.
  • Your app will need Appboy’s SDK and Adjust’s SDK installed.

Step 2: Modifying your app code

Appboy’s integration with Adjust is an SDK-to-SDK integration, meaning that attribution data is collected by Adjust’s API and then sent to Appboy through the Appboy SDK. For this to work, you will need to modify your app’s code.

On iOS, you will need to modify your app code to register an attribution callback with Adjust that calls setAttributionData from Appboy’s SDK. Example code snippet:

- (void)adjustAttributionChanged:(ADJAttribution *)attribution {
  ABKAttributionData *attributionData = [[ABKAttributionData alloc]
                                         initWithNetwork:attribution.network
                                         campaign:attribution.campaign
                                         adGroup:attribution.adgroup
                                         creative:attribution.creative];
  [[Appboy sharedInstance].user setAttributionData:attributionData];
}

On Android, you will need to modify your app code to set a listener for Adjust attribution changes that calls setAttributionData from Appboy’s SDK. Example code snippet:

config.setOnAttributionChangedListener(new OnAttributionChangedListener() {
  @Override
  public void onAttributionChanged(AdjustAttribution attribution) {
    Appboy.getInstance(getApplicationContext()).getCurrentUser().setAttributionData(new AttributionData(
        attribution.network,
        attribution.campaign,
        attribution.adgroup,
        attribution.creative));
  }
});

Assuming you configure your integration as suggested above, Appboy will map Adjust’s data to segment filters in the following way:

Adjust Attribution Parameter Appboy Segment Filter
{network_name} Attributed Source
{campaign_name} Attributed Campaign
{adgroup_name} Attributed Adgroup
{creative_name} Attributed Ad

AppsFlyer

Step 1: Integration Requirements

  • This integration supports iOS and Android apps.
  • If you expect more than 100 attributed installs per hour, you will need an Appboy Enterprise account. See API Restrictions for more information.
  • Your app will need Appboy’s SDK and AppsFlyer’s SDK installed.
  • If you have an iOS app, you will need to enable IDFA collection in Appboy’s SDK.
  • If you have an Android app, you will need to include the code snippet below, which passes a unique Appboy device id to AppsFlyer. For most setups, this code should be included alongside all calls to AppsFlyerLib.setAppsFlyerKey, typically in an activity’s onCreate callback.
HashMap<String, Object> customData = new HashMap<String,Object>();
String deviceId =(Appboy.getInstance(MyActivity.this).getInstallTrackingId());
customData.put("customData", deviceId);
AppsFlyerLib.setAdditionalData(customData);

Step 2: Getting the Appboy API Key

In Appboy’s Dashboard, navigate to “3rd Party Integrations” > “Attribution” and find the API key in the AppsFlyer section. You will need to provide this key to Appsflyer in the next step.

Step 3: Configure Appboy in Appsflyer’s Dashboard

  • In Appsflyer’s dashboard, navigate to the “Integrated Partners” page.
  • On that page, search for Appboy and click on Appboy’s logo to open up a configuration window.
  • Under “Integration Parameters” select “enable”.
  • Copy the Appboy API key (obtained in the prior step) into the “API_key” field.
  • Click “Save & Close”.

Additional information on these instructions is available in Appsflyer’s documentation.

Appboy maps AppsFlyer’s data fields to segment filters in the following way

AppsFlyer Data Field Appboy Segment Filter
media_source Attributed Source
campaign Attributed Campaign
af_adset Attributed Adgroup
af_ad Attributed Ad

Step 4: Confirming the Integration

Once Appboy receives attribution data from AppsFlyer, the status connection indicator on “3rd Party Integrations” > “Attribution” will change to green and a timestamp of the last successful request will be included. Note that this will not happen until we receive data about an attributed install. Organic installs, which should be excluded by the AppsFlyer integration, are ignored by our API and are not counted when determining if a successful connection was established.

Apsalar

Step 1: Integration Requirements

  • This integration supports iOS apps only.
  • If you expect more than 100 attributed installs per hour, you will need an Appboy Enterprise account. See API Restrictions for more information.
  • Your app will need Appboy’s SDK and Apsalar’s SDK installed.
  • You will need to enable IDFA collection in Appboy’s SDK.

Step 2: Getting the Postback URL

In Appboy’s Dashboard, navigate to “3rd Party Integrations” > “Attribution” and find the Postback URL in the Apsalar section. This url represents the API endpoint that an attribution partner will send data to. You will need this url in the next step when setting up a callback in Apsalar’s dashboard.

Step 3: Setting Up A Postback from Apsalar

Follow these instructions to add a postback in Apsalar’s dashboard. The postback should point to the Postback URL you copied from Appboy’s Dashboard in Step 2. The postback should be for install events only and should be configured to exclude organic installs.

Appboy maps Apsalar’s Postback Macros to segment filters in the following way:

Apsalar Postback Macro Appboy Segment Filter
{NETWORK} Attributed Source
{CID} Attributed Campaign
{GID} Attributed Adgroup
{CREATIVE} Attributed Ad

Step 4: Confirming the Integration

Once Appboy receives attribution data from Apsalar, the status connection indicator on “3rd Party Integrations” > “Attribution” will change to green and a timestamp of the last successful request will be included. Note that this will not happen until we receive data about an attributed install. Organic installs, which should be excluded from the Apsalar postback, are ignored by our API and are not counted when determining if a successful connection was established.

Branch

Step 1: Integration Requirements

  • This integration supports iOS apps only.
  • If you expect more than 100 attributed installs per hour, you will need an Appboy Enterprise account. See API Restrictions for more information.
  • Your app will need Appboy’s SDK and Branch’s SDK installed.
  • You will need to enable IDFA collection in Appboy’s SDK.

Step 2: Getting the Attribution ID

In Appboy’s Dashboard, navigate to “3rd Party Integrations” > “Attribution” and find the API Key in the Branch section. This key is used in the next step when setting up a webhook in Branch’s dashboard.

Step 3: Setting Up A Webhook from Branch

Follow these instructions to add a webhook in Branch’s dashboard. You will be prompted for the key that you found in Appboy’s Dashboard in Step 2.

Step 4: Confirming the Integration

Once Appboy receives attribution data from Branch, the status connection indicator on “3rd Party Integrations” > “Attribution” will change to green and a timestamp of the last successful request will be included. Note that this will not happen until we receive data about an attributed install. Organic installs are ignored by our API and are not counted when determining if a successful connection was established.

Kochava

Step 1: Integration Requirements

  • This integration supports iOS apps only.
  • If you expect more than 100 attributed installs per hour, you will need an Appboy Enterprise account. See API Restrictions for more information.
  • Your app will need Appboy’s SDK and Kochava’s SDK installed.
  • You will need to enable IDFA collection in Appboy’s SDK.

Step 2: Getting the Attribution ID

In Appboy’s Dashboard, navigate to “3rd Party Integrations” > “Attribution” and find the API Key in the Kochava section. This key is used in the next step when setting up a postback in Kochava’s dashboard.

Step 3: Setting Up A Postback from Kochava

Follow these instructions to add a postback in Kochava’s dashboard. You will be prompted for the key that you found in Appboy’s Dashboard in Step 2.

Step 4: Confirming the Integration

Once Appboy receives attribution data from Kochava, the status connection indicator on “3rd Party Integrations” > “Attribution” will change to green and a timestamp of the last successful request will be included. Note that this will not happen until we receive data about an attributed install. Organic installs are ignored by our API and are not counted when determining if a successful connection was established.

Tune (MobileAppTracking)

Step 1: Integration Requirements

  • This integration supports iOS, Android, and Windows Universal apps.
  • If you expect more than 100 attributed installs per hour, you will need an Appboy Enterprise account. See API Restrictions for more information.
  • Your app will need Appboy’s SDK and Tune’s SDK installed.
  • If you have an iOS app, you will need to enable IDFA collection in Appboy’s SDK.
  • If you have an Android app, you will need to include the code snippet below, which passes a unique Appboy device id to Tune. For most setups, this code should be included alongside all calls to mobileAppTracker.setAndroidId or mobileAppTracker.setGoogleAdvertisingId, typically in an activity’s onCreate callback.
mobileAppTracker.setUserId(Appboy.getInstance(MyActivity.this).getInstallTrackingId());

Step 2: Getting the Postback URL

In Appboy’s Dashboard, navigate to “3rd Party Integrations” > “Attribution” and find the Postback URL in the MobileAppTracking section. This url represents the api endpoint that an attribution partner will send data to. You will need this url in the next step when setting up a callback in Tune’s dashboard.

Step 3: Setting Up A Postback from Tune

Follow these instructions to set up a postback in Tune’s dashboard so that it sends attribution data to Appboy. This should be configured to send to the Postback URL you copied from Appboy’s Dashboard in Step 2. Also configure the Postback to only send data for non-organic installs.

Appboy maps Tune’s Postback Macros to segment filters in the following way

Tune Postback Macro Appboy Segment Filter
{advertiser_sub_publisher} Attributed Source
{advertiser_sub_campaign} Attributed Campaign
{advertiser_sub_adgroup} Attributed Adgroup
{advertiser_sub_ad} Attributed Ad

Step 4: Confirming the Integration

Once Appboy receives attribution data from Tune, the status connection indicator on “3rd Party Integrations” > “Attribution” will change to green and a timestamp of the last successful request will be included. Note that this will not happen until we receive data about an attributed install. Organic installs, which should be excluded from the Tune postback, are ignored by our API and are not counted when determining if a successful connection was established.

Zendesk Integration

Follow the instructions on this page to get started with your Zendesk integration.

Estimated Time: 10 Minutes

Obtaining Zendesk Credentials

Note: These instructions assume that you have already created a Zendesk account. If you have not, follow the instructions here.

Step 1

Log in to Zendesk here.

Step 2

Navigate to the settings page on the bottom of the Zendesk dashboard as shown below:

Zendesk Settings Page

Step 3

On your settings page, scroll down the dashboard on the left and click the ‘API’ label under the ‘Channels’ header. Once on this page, check the ‘Enabled’ box under ‘Settings’ to reveal the necessary information for your integration.

Zendesk Token

Linking Appboy to Zendesk

If you have not already registered, create an Appboy account on appboy.com. Then follow the app group configuration documentation to setup your first app.

Step 1

Navigate to the ‘3rd Party Integrations’ page on the Appboy Dashboard under the ‘APP SETTINGS’ section and click the ‘Feedback’ tab.

Feedback Settings

Step 2

On the Feedback Integration page, input your Zendesk URL, email address and Zendesk API in the designated fields.

Linking Appboy and Zendesk

Integration Complete

Zendesk should now be integrated into your Appboy account. To confirm a successful integration you should see new user feeback data tracked as tickets on the Zendesk dashboard.

Sync Direction

Currently, Appboy only supports single-way ticket creation through Zendesk. This mean that comments or changes to Zendesk changes will not be reflected on the Appboy feedback page.

What Appboy Sends to Zendesk

Once Zendesk is fully integrated into your Appboy dashboard, your Zendesk account will automatically receive any user-submitted feedback/issues that are sent after that point. This means that pre-existing issues must be entered into your Zendesk dashboard manually.

Succesful Zendesk Integration

Note: Appboy profile fields are included in the body of the ticket.

Fields Sent to Zendesk

  • Name
  • Email
  • Session Count
  • Median Session Duration
  • First Used App
  • Last Used App
  • External ID
  • Twitter Username
  • Image
  • City
  • Country
  • Locale
  • Number of Twitter Followers
  • Number of Twitter Following
  • Number of Tweets
  • Number of Facebook Friends
  • Facebook Likes
  • Feedback Count

Note: These fields are not customizable, but null fields are not sent.

Desk Integration

Follow the instructions on this page to get started with your Desk integration.

Linking Appboy to Desk

Note: These instructions assume that you have already created a Desk account. If you have not, follow the instructions here.

Step 1

Navigate to the ‘3rd Party Integrations’ page on the Appboy Dashboard under the ‘APP SETTINGS’ section and click the ‘Feedback’ tab.

Feedback Settings

Step 2

On the Feedback Integration page, input your Desk URL, email address and Desk password in the designated fields as shown below.

Linking Appboy and Desk

Integration Complete

Desk should now be integrated into your Appboy account. To confirm a successful integration you should see new user feeback data tracked as cases in your Desk Inbox.

Sync Direction

Currently, Appboy only supports single-way case creation through Desk. This mean that comments or changes to Desk changes will not be reflected on the Appboy feedback page.

What Appboy Sends to Desk

Once Desk is fully integrated into your Appboy dashboard, your Desk account will automatically receive any user-submitted feedback/issues that are sent after that point. This means that pre-existing issues must be entered into your Desk dashboard manually.

Successful Integration

Some Appboy profile fields are included in the body of the ticket. Additonal fields from the profile are attached as custom fields to the case. To get these to display add the custom fields to your cases through your Desk admin page.

Desk Custom Fields

The fields that can be added are

Name Key Data Type
User ID user_id Text
Gender gender Text
Age Group age_group Text
Country country Text
Language language Text
Timezone timezone Text
Sessions session_count Number
Last Used last_used Date
First Used first_used Date
App Version app_version Text
Device device Text
Device OS device_os Text

AWS S3 Integration

Follow the instructions on this page to get started with your AWS S3 integration. AWS S3 integration is required for advanced data export functionality.

Obtaining AWS S3 Credentials

If you already have an S3 bucket, we still recommend creating a new bucket for Appboy so you can limit permissions.

Step 1

To create a bucket for your app, open the Amazon S3 console and follow the instructions to Sign in or Create an Account with AWS.

Step 2

Once signed in, select ‘S3’ from the ‘Storage & Content Delivery’ Category.

S3 Creds

Step 3

Select ‘Create Bucket’ on the next screen and you’ll be prompted to create your bucket and select a region. Click here for information on Bucket Restrictions and Limitations, as well as naming conventions.

Create Bucket

Step 4

To retrieve your access ID and secret access key, you’ll need to create your first IAM User and Administrators Group. Follow these step-by-step instructions.

Step 5

Once a user has been created, please select ‘Show User Security Credentials’ so your Access Key ID and Secret Access Key will be revealed. Click the blue ‘Download Credentials’ button as you will need to input this into the Appboy dashboard later on.

Secret Key

Step 6

Now, you’ll need to navigate to the Policies tab in the navigation bar and select ‘Get Started’ then ‘Create Policy’ which will allow you to add permissions for your user. Select ‘Create Your Own Policy’. This will give limited permissions so we only have the ability to access the bucket that you specify.

Policy

Below is the code you need to input when creating your own policy. You will have to specify a ‘Policy Name’ of your choice, and input the code below into the ‘Policy Document’ section. Be sure to replace ‘INSERTBUCKETNAME’ with your own bucket name.

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": ["s3:ListBucket", "s3:GetBucketLocation"],
      "Resource": ["arn:aws:s3:::INSERTBUCKETNAME"]
    },
    {
      "Effect": "Allow",
      "Action": [
        "s3:GetObject",
        "s3:PutObject",
        "s3:DeleteObject"
      ],
      "Resource": [
        "arn:aws:s3:::INSERTBUCKETNAME*",
        "arn:aws:s3:::INSERTBUCKETNAME/",
        "arn:aws:s3:::INSERTBUCKETNAME"
      ]
    }
  ]
}

Step 7

Once your policy has been created, you will need to select ‘Users’ and then click into your specifc user so you can attach this new policy. On the ‘Permissions’ tab, click ‘Attach Policy’.

Attach User

Search for the new policy that you created and click to attach.

You are now ready to link your AWS credentials to your Appboy account.

Linking Appboy to AWS S3

If you have not already registered, create an Appboy account on appboy.com. Then follow the app group configuration documentation to setup your first app.

Step 1

Navigate to the ‘3rd Party Integrations’ page on the Appboy Dashboard under the ‘APP SETTINGS’ section and click the ‘AWS Credentials’ tab.

AWS Creds

Step 2

On the AWS Credentials page, input your AWS Access ID, AWS Secret Access Key, and AWS S3 Bucket Name in the designated fields. When inputting your secret key, click ‘Test Credentials’ first to ensure your credentials work, then ‘Save’ once this is successful.

Note: You can always retrieve new credentials by navigating to your user and clicking ‘Create Access Key’ on the Security Credentials Tab within the AWS Console.

Integration Complete

AWS S3 should now be integrated into your Appboy account. A notification will inform you if your credentials have been successfully validated.

Apteligent Integration

Appboy is dedicated to creating partner integrations that provide data-driven approaches to improving your application’s user experience. The Apteligent and Appboy partnership combines Appboy’s multichannel engagement automation with Apteligent’s detailed crash reporting, allowing you to log critical data into your existing Appboy solution. Together, Apteligent and Appboy can help you segment, understand, and engage with your users who have experienced application crashes.

Note: This integration is currently only supported on iOS.

iOS Integration

To integrate Apteligent with Appboy on iOS, do the following:

Step 1

Register an observer. Ensure that this is done before you initialize Apteligent.

[[NSNotificationCenter defaultCenter] addObserver:self
                                         selector:@selector(crashDidOccur:)
                                             name:@"CRCrashNotification"
                                           object:nil];

Step 2

The Apteligent SDK will fire a notification when the user loads the application after a crash occurs. The notification will contain the crash name, reason, and date of occurrence.

Upon receiving the notification, log a custom crash event and update user attributes with Apteligent’s crash reporting analytics:

- (void)crashDidOccur:(NSNotification*)notification {
  NSDictionary *crashInfo = notification.userInfo;
  [[Appboy sharedInstance] logCustomEvent:@"ApteligentCrashEvent" withProperties:crashInfo];
  [[Appboy sharedInstance].user setCustomAttributeWithKey:@"lastCrashName" andStringValue:crashInfo[@"crashName"]];
  [[Appboy sharedInstance].user setCustomAttributeWithKey:@"lastCrashReason" andStringValue:crashInfo[@"crashReason"]];
  [[Appboy sharedInstance].user setCustomAttributeWithKey:@"lastCrashDate" andDateValue:crashInfo[@"crashDate"]];
}

That’s it! Now you’ll be able to harness the power of Appboy’s segmentation, analytics, and engagement using the crash information that Apteligent provides.

Implementation Example

See our sample implementation in the AppDelegate.m file of the Stopwatch sample application.

Quark App Studio Integration

The instructions on this page will help Quark App Studio apps get started on their Appboy integration. You’ll find details on how to fill out the following form:

Form

Getting Set Up

Before you begin filling out the form, take the following steps:

  1. If you have not already registered, create an Appboy account on appboy.com.
  2. Follow the app group configuration documentation to set up your first app. During this step, you can set up your production and development (testing) apps. Completing this will give you information necessary for filling out the form.

App Group ID

  1. In your Appboy Dashboard, go to the menu bar and click on Developer Console, which is located under App Settings.
  2. You will see your App Group ID in the API Settings tab:

App_group_ID

iOS Segment ID

  1. In your Appboy Dashboard, make sure you’re in your Production app group.
  2. Navigate to the Segments page, which is located under Engagement in the lefhand menu bar.
  3. Check to see if there is a segment called “All Users (Your App’s Name - iOS).” If so, click on that segment and skip to step 5. If not, go to step 4.
  4. Create a segment called All iOS Users that contains all of your app’s iOS users. When creating the segment, go to the Apps Used section and ensure that only your iOS app is checked. In addition, make sure there are no filters are applied. (The segment statistics for your app will differ from what you see in our sample screenshot).
  5. Staying on the page for the segment of all iOS users, scroll down to find your Segment API Identifier.

All_iOS

Android Segment ID

  1. In your Appboy Dashboard, make sure you’re in your Production app group.
  2. Navigate to the Segments page, which is located under Engagement in the lefhand menu bar.
  3. Check to see if there is a segment called “All Users (Your App’s Name - Android).” If so, click on that segment and skip to step 5. If not, go to step 4.
  4. Create a segment called All Android Users that contains all of your app’s Android users. When creating the segment, go to the Apps Used section and ensure that only your Android app is checked. In addition, make sure there are no filters are applied. (The segment statistics for your app will differ from what you see in this sample screenshot).
  5. Staying on the page for the segment of all Android users, scroll down to find your Segment API Identifier.

All_Android

All Devices Segment ID

  1. In your Appboy Dashboard, make sure you’re in your Production app group.
  2. Navigate to the Segments page, which is located under Engagement in the lefhand menu bar.
  3. Create a segment called All Users that contains all iOS and Android users. In the Apps Used section, check “Include users from all apps,” which will select both your Android and iOs app. Do not apply any filters. (The segment statistics for your app will differ from what you see in this sample screenshot).
  4. Staying on the page for the All Users segment, scroll down to find your Segment API Identifier.

All

GCM Sender ID

Your GCM Sender ID is your Google Project Number. Here are instructions on how to access it in the Google Developers Console.

Production Details

iOS API Key

  1. In your Appboy Dashboard, make sure you are in your Production App Group.
  2. Go to the menu bar and click on Manage App Group, which is located under App Settings.
  3. In the App Settings tab, select your iOS production app. Make sure to click on the correct app.
  4. You’ll see your app’s iOS API key:

Production_iOS

Android API Key

  1. In your Appboy Dashboard, make sure you are in your Production App Group.
  2. Go to the menu bar and click on Manage App Group, which is located under App Settings.
  3. In the App Settings tab, select your Android production app. Make sure to click on the correct app.
  4. You’ll see your app’s Android API key:

Production_Android

Development Details

iOS API Key

The steps below are similar to those for accessing your Production iOS API Key, except for you carry them out within your Development app group.

  1. In your Appboy Dashboard, make sure you are in your Development App Group.
  2. Go to the menu bar and click on Manage App Group, which is located under App Settings.
  3. In the App Settings tab, select your iOS development app. Make sure to click on the correct app.
  4. You’ll see your app’s iOS API key listed.

Android API Key

The steps below are similar to those for accessing your Production Android API Key, except for you carry them out within your Development app group.

  1. In your Appboy Dashboard, make sure you are in your Development App Group.
  2. Go to the menu bar and click on Manage App Group, which is located under App Settings.
  3. In the App Settings tab, select your Android development app. Make sure to click on the correct app.
  4. You’ll see your app’s Android API key listed.

Zapier Integration

Zapier is an automation tool that links software services together, similar to IFTTT (if this then that) for enterprise software. Utilizing Webhooks and API Triggered Campaigns, Appboy can integrate with Zapier

Step 1: Add Wordpress as a Trigger and select New Post after you connect your account:

zapier1

Step 2: When Post Status is Published:

zapier2

Step 3: Add an Action “Webhook”:

zapier3

Step 4: Choose Post as the Type:

zapier4

Step 5: Setup Appboy Post:

URL: https://api.appboy.com/campaigns/trigger/send Payload Type: JSON Data:

zapier5

trigger_properties__name

app_group_id and campaign_id are generated when you create a campaign and select API Triggered Delivery.

Step 6: Create Appboy Campaign:

zapier6

You can also use trigger_properties with Liquid Logic to filter what or if the message is sent.

Third Party Liability

Appboy or third parties may refer to third party products or functionality within the Appboy online Documentation. Any use by a customer of such third party services or functionality, and any exchange of data between a customer and such third party, is solely between that customer and that third party. Appboy does not warrant any third party services or functionality and shall have no liability in connection with a customer’s use thereof.

Foursquare Integration

To unlock even more powerful location-based campaign targeting, Appboy provides a seamless product integration with location intelligence company Foursquare. You can use Foursquare’s Pilgrim SDK on iOS and Android to provide real-time event triggering based upon your users’ location in the physical world, allowing you to harness Foursquare’s powerful geotargeting capabilities and take action with Appboy.

This partnership integration opens up a variety of powerful use-cases to help you personalize your users’ experiences:

  • Send customers a notification when they arrive at or leave a particular location based upon Foursquare contextual data, such as a concert venue or Home.
  • Trigger coupons or promotions for high-value customers when they arrive at a location.
  • Gather key demographic or behavioral data over time for richer retargeting.

Integration Details

To enable this integration, first integrate the Appboy and Foursquare Pilgrim SDKs on Android and iOS. To integrate the Pilgrim SDK you simply add a few lines of code to your AppDelegate on iOS or MainActivity class on Android. You’ll then instantly began receiving visit events on the device or to a webhook - even when your app isn’t running.

In order to properly map the Appboy and Foursquare SDKs, you will need to set the same user ID in both systems, using the changeUser method in the Appboy SDK and the setUserId method of PilgrimUserInfo in the Pilgrim SDK.

Next, find your App Group and App IDs on the Developer Console section of the Appboy Dashboard.

Appboy Developer Console

Enter your Appboy App Group ID and (optionally) App IDs in the Foursquare Pilgrim Console:

Pilgrim Developer Console

Once you have configured the Pilgrim Console, the Pilgrim SDK will automatically track location events and forward them to Appboy, allowing you to retarget and segment your customers. See the Foursquare developer site for more details.

Note that the Pilgrim SDK requires that you enable location services.

Triggering Messages based upon Location events

You can set up a Campaign or Canvas in the Appboy Dashboard that will action off of location events generated by the Pilgrim SDK. This integration route is ideal for real-time messaging right as users enter a venue of interest, or delayed follow-on communication after they’ve left it (e.g. a thank you note or reminder).

For example, you can setup an Action-Based Campaign within Appboy that will send messages when a user arrives at home. Create a Campaign (or a Canvas) in Appboy, and set it to send using Action-Based Delivery. For your trigger, use a Custom Event of arrival with an event property filter for locationType as shown below:

Pilgrim Developer Console

Retargeting users based upon their last known location

You can use the Pilgrim SDK to set a last_location Custom Attribute on your Appboy users’ User Profiles. You can then use the “matches regex” comparison to retarget users who went to a particular location in the real world: for example, segmenting all users who were recently at a pizza place.

Pilgrim Developer Console

You can also segment users in Appboy who visited a particular type of venue, based on Foursquare’s primaryCategoryId in a particular window of time.

Pilgrim Developer Console

To identify the users and properties used by the Foursquare API and Pilgrim SDK, please refer to the Foursquare developer site.