1. Home
  2. WalkMe Mobile
  3. Mobile: Analytics and AI
  4. Mobile: Additional Mobile APIs
  5. Mobile: What Is The Campaign Trigger API and How Is It Used?

Mobile: What Is The Campaign Trigger API and How Is It Used?

Updated on November 14, 2018
Download PDF

Brief Overview

In addition to automatic Triggers (Static and Happy Moment), Campaigns can be triggered by a unique API call integrated to the app.

The API trigger is useful for activating Campaigns by an action performed in your app, such as a button tap or a screen transition. For example, if there is nothing in the app to key a segment off of, you can set an API trigger to precisely determine the moment when a Campaign will start.

Steps For Enabling the API Trigger in the Mobile Console

The API trigger requires setting a key by which the Campaign will start, which can be done by clicking on the Advanced button next to the trigger setting in the Campaign Wizard’s EDIT AUDIENCE tab.

  1. Click Advanced:
  2. Toggle API trigger on and enter API key:

How To Integrate API Triggers With Your App

Android

Trigger a campaign without redirect

ABBI.trigger("my-key");

Trigger a campaign after redirecting the user to a deeplink in the app

ABBI.trigger("my-key","myapp://deep_link");

iOS

Trigger a campaign without redirect

[ABBI trigger:@"my-key"];

Trigger a campaign after redirecting the user to a deeplink in the app

[ABBI trigger:@"my-key" withDeepLink:@"myapp://deep_link"];

Was this article helpful?

Related Articles