Skip to content

Behavior Events

Setup

iOS Setup

Update your app.json to include the movable_ink_api_key and movable_ink_region in the infoPlist section:

Key Description
movable_ink_api_key Your MovableInk SDK API Key - Required for using Behavior Events
movable_ink_region Your MovableInk Region - Required for using Behavior Events 
{
  "expo": {
    "scheme": "myapp",
    "ios": {
      "associatedDomains": [
        "applinks:mi.domain.com"
      ],
      "infoPlist": {
        "movable_ink_universal_link_domains": [
          "mi.domain.com"
        ],
        "movable_ink_api_key": "API KEY",
        "movable_ink_region": "us" // or "eu"
      }
    }
  }
}

Android Setup

You'll need to add a plugin to set your API Key:

At the root of your project, create a folder called plugins if it doesn't already exist. In that plugins folder, create a file called mi_plugin.js

.
|- app/
|  └─ plugins/
|      └─ mi_plugin.js

Add the following content:

// mi_plugin.js
const { withAndroidManifest, withAppBuildGradle } = require('@expo/config-plugins');

module.exports = function movableInkPlugin(config, data) {
  // Handle AndroidManifest.xml
  config = withAndroidManifest(config, async (config) => {
    let androidManifest = config.modResults.manifest;

    // Handle application-level modifications
    if (androidManifest.application && androidManifest.application[0]) {
      const application = androidManifest.application[0];

      // Initialize meta-data array if it doesn't exist
      if (!application['meta-data']) {
        application['meta-data'] = [];
      }

      // Handle Movable Ink API key
      if (data.movable_ink_android_api_key) {
        application['meta-data'].push({
          $: {
            'android:name': 'com.movableink.inked.API_KEY',
            'android:value': data.movable_ink_android_api_key,
          },
        });
      }
    }

    return config;
  });

  // Handle build.gradle
  config = withAppBuildGradle(config, (config) => {
    const { modResults } = config;

    if (data.movable_ink_android_region) {
      const region = data.movable_ink_android_region.toUpperCase();

      // Add buildConfigField to defaultConfig
      const buildConfigField = `buildConfigField("String", "MOVABLE_INK_SDK_REGION", "\\"${region}\\"")`;

      // Find defaultConfig block and add the buildConfigField
      if (modResults.contents.includes('defaultConfig {')) {
        modResults.contents = modResults.contents.replace(
          /defaultConfig\s*\{/,
          `defaultConfig {\n        ${buildConfigField}`
        );
      }
    }

    return config;
  });

  return config;
};

Update your app.json to include the plugin:

{
  "expo": {
    "plugins": [
      [
        "./plugins/mi_plugin",
        {
          "movable_ink_android_api_key": "API KEY",
          "movable_ink_android_region": "US" // or "EU"
        }
      ]
    ]
  }
}

Setting MIU (mi_u)

An MIU is an identifier used by your companies marketing team and email/mobile messaging provider, that when shared with MovableInk, allows to uniquely identify each of your customers when the interact with campaigns or any other MovableInk content.

Most distribution partners provide a unique user identifier as an available merge tag that distinctly identifies every recipient on your list(s). Using this merge tag allows MovableInk to provide users with a consistent experience when opening the same email multiple times and across multiple devices. Providing an MIU is required for accurate behavior and conversion tracking.

You'll need to work with your distribution partners to identify a unique user identifier. It must meet the following criteria:

You should make the following call as soon as the user is identified (usually after logging in) to set the MIU. Double check with your marketing team that the MIU you're using matches the values they are using. It's imperative that they match for accurate behavior event tracking.

RNMovableInk.setMIU("YOUR_MIU");

If your app has support for guest/anonymous users, you can still track events without setting an MIU. Once a user does login, you should call RNMovableInk.setMIU() with the MIU of the user, then call RNMovableInk.identifyUser(). This will attempt to associate any events that user made as a guest to this user.

Inherited MIUs

If a user interacts with a MovableInk Link that contains an MIU and deeplinks into your app, the SDK will use that MIU value automatically for all subsequent behavior events if you don't manually set an MIU.

If you manually set an MIU, events will use that instead.

Suggested MIU naming convention

We strongly recommend you use a UUID for MIUs.

If you find your ids include names, email addresses, timestamps, or are easily incremental (1, 2, 3), we suggest using a new naming method that is more secure so that your MIUs are not as easy to guess or impersonate.

Recommended NOT Recommended
42772706-c225-43ad-837e-c01e94907c3c user@example.com
d68d3dbe-86e1-43ce-bf5f-2dafd2f6af45 123456789
6ec4f1dd-0998-4ca8-8793-7511c2625a45 john-smith-123

Product Searched

Key Type Description Max
query String, required The query the user used for a given search 256
url String A URL for the given query 512
meta Record<String, unknown> An open Record of any extra data you'd like to associate to this event. The Value must be either a String, Boolean, or Numeric. Meta does not accept nested objects or arrays. 20 Items 
RNMovableInk.productSearched({ query: 'Test Event' });

Product Viewed

Key Type Description Max
id String, required The ID of a product 256
title String The title of the product 512
price String The price of the product in Dollars and Cents. Do not include currency or any other non-decimal digit characters.
currency Currency Enum The currency of the price. Defaults to USD. Introduced in v2. -
url String The URL of the product 512
categories Array<ProductCategory> An array of ProductCategory associated with the product. A ProductCategory must contain an id (String) and optionally a url (String) and/or title (String) 10 Items
meta Record<String, unknown> An open Record of any extra data you'd like to associate to this event. The Value must be either a String, Boolean, or Numeric. Meta does not accept nested objects or arrays. 20 Items 
RNMovableInk.productViewed({
  id: "1",
  title: "Hyperion",
  price: "15.99",
  currency: Currency.USD,
  url: "https://inkrediblebooks.com/hyperion-dan-simmons",
  categories: [
    {
      id: "Sci-Fi",
      url: "https://inkrediblebooks.com/categories/scifi"
    },
    {
      id: "Fiction",
      url: "https://inkrediblebooks.com/categories/fiction"
    }
  ],
  meta: { pages: 496 }
});

v2

The currency key is introduced in v2. If you're using a version < v2, simply remove currency.

Order Completed

Key Type Description Max
id String The ID of a order 256
revenue String The total of the order in Dollars and Cents. Do not include currency or any other non-decimal digit characters.
currency Currency Enum The currency of the price. Defaults to USD. Introduced in v2. -
products Array<OrderCompletedProduct> An array of the products in an order. OrderCompletedProduct must contain an id (String), and optionally a price (String), quantity (Number), title (String), url (String), and meta (Record<String, unknown>). 100 Items 
RNMovableInk.orderCompleted({
  id: "1",
  revenue: "15.99",
  currency: Currency.USD,
  products: [
    {
      id: "1",
      price: "15.99",
      quantity: 1,
      title: "Hyperion",
      url: "https://inkrediblebooks.com/hyperion-dan-simmons",
      meta: { pages: 496 }
    }
  ]
});

v2

The currency key is introduced in v2. If you're using a version < v2, simply remove currency.

Testing Behavior Events

When you're ready to test an event, you need to set the MIU to a known value. You should let your Movable Ink client experience team know that you're ready to start testing events and give them the MIU that you are going to use before you do so. This will allow them to verify that the events are being sent correctly.

We usually use an empty UUID for testing, such as 00000000-0000-0000-0000-000000000000.

When you're ready to test an event, you should open the Console app on your Mac, select your device on the sidebar, then press the start button on the top bar. To filter the logs to just view MovableInk SDK logs, search for MI SDK.

When you send an event, you should see the event logged in the console. If the event was structured correctly, you should see a success message in the console along side the event name.