Behavior Events

Setup

Android Setup

If you want to use the Behavior Events features of the SDK, you'll need an API Key to enable Behavior Events for your app. If you don't already have one, please reach out to your Movable Ink client experience team at MovableInk with your applications bundle identifier (both Android and iOS).

Open local.properties file, found at android > local.properties

Within the application's local.properties, the provided API Key should be specified as follows:

MOVABLE_INK_SDK_API_KEY = "XXX"

Also, in the application manifest file the following meta-data tag should be specified within the application tag:

<meta-data
  android:name="com.movableink.inked.API_KEY"
  android:value="${MOVABLE_INK_SDK_API_KEY}"
/>

Lastly, in the Application level gradle file, under the defaultConfig section:

defaultConfig {
    ....
    manifestPlaceholders["MOVABLE_INK_SDK_API_KEY"] = localProperties['MOVABLE_INK_SDK_API_KEY']
    ....
}

Configuring The SDK Region:

To ensure compliance with regional requirements , we now require you to specify your region(importantly for EU clients). This is necessary to properly route your data and comply with local regulations.

In your project's build.gradle (or build.gradle.kts) file, define a gradle property to your project's defaultConfig block to specify the region:

defaultConfig {
    // Existing configurations...

    // Set your region (default is US, set EU for European clients)
    buildConfigField("String", "MOVABLE_INK_SDK_REGION", "EU")

}

If you don't supply a region, the SDK will default to the US region. If you are unsure which region your company was setup in on the MovableInk Platform, please reach out to your Movable Ink client experience team.

After making changes to the gradle file, perform a gradle sync.

iOS Setup

You'll need an API Key to enable Behavior Events for your app. If you don't already have one, please reach out to your Movable Ink client experience team at MovableInk with your applications bundle identifier.

Once you have an API Key, you can add two key/value pair in your applications Info.plist, movable_ink_api_key and movable_ink_region.

movable_ink_region must be one of following:

us
eu

<key>movable_ink_api_key</key>
  <string>YOUR_API_KEY</string>
<key>movable_ink_region</key>
  <string>eu</string>

If you don't supply a region, the SDK will default to the US region. If you are unsure which region your company was setup in on the MovableInk Platform, please reach out to your Movable Ink client experience team.

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:

Unique per recipient
Does not vary between individual sends for that channel
A URL-friendly string What does URL friendly mean?
Does not contain personally identifying information (PII) What qualifies as PII?

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.

 _movableInkPlugin.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 _movableInkPlugin.setMIU() with the MIU of the user, then call _movableInkPlugin.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	Map<String, dynamic>	An open Map 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

final Map<String, dynamic> properties = {
  "query": "hyperion",
  "url": "https://inkrediblebooks.com/search?q=hyperion",
  "meta": { "pages": 496 }
};

_movableInkPlugin.productSearched(properties);

DaVinci Enabled - SDK v2

DaVinci will automatically receive the Product Searched event for DaVinci customers

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	String	The currency of the price. Defaults to USD. Introduced in v2.	-
url	String	The URL of the product	512
categories	List<Map<String, String>>	A List of Categories associated with the product. A Category is a Map<String, String> that must contain an id (String) and optionally a url	10 Items
meta	Map<String, dynamic>	An open Map 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

final Map<String, dynamic> properties = {
  "id": "1",
  "title": "Hyperion",
  "price": "15.99",
  "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 }
};

_movableInkPlugin.productViewed(properties);

There's also a Currency enum available with all of the supported values:

final Map<String, dynamic> properties = {
  "id": "1",
  "title": "Hyperion",
  "price": "15.99",
  "currency": Currency.USD.value,
  "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 }
};

_movableInkPlugin.productViewed(properties);

DaVinci Enabled - SDK v2

DaVinci will automatically receive the Product Viewed event for DaVinci customers

v2

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

Product Added

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	String	The currency of the price. Defaults to USD. Introduced in v2.	-
url	String	The URL of the product	512
categories	List<Map<String, String>>	A List of Categories associated with the product. A Category is a Map<String, String> that must contain an id (String) and optionally a url	10 Items
meta	Map<String, dynamic>	An open Map 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

final Map<String, dynamic> properties = {
  "id": "1",
  "title": "Hyperion",
  "price": "15.99",
  "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 }
};

_movableInkPlugin.productAdded(properties);

v2

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

Product Removed

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	String	The currency of the price. Defaults to USD. Introduced in v2.	-
url	String	The URL of the product	512
categories	List<Map<String, String>>	A List of Categories associated with the product. A Category is a Map<String, String> that must contain an id (String) and optionally a url	10 Items
meta	Map<String, dynamic>	An open Map 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

final Map<String, dynamic> properties = {
  "id": "1",
  "title": "Hyperion",
  "price": "15.99",
  "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 }
};

_movableInkPlugin.productRemoved(properties);

v2

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

Category Viewed

Key	Type	Description	Max
id	String, required	The ID of a category	256
title	String	The title of the category	512
url	String	The URL of the category	512
meta	Map<String, dynamic>	An open Map 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

final Map<String, dynamic> properties = {
  "id": "scifi",
  "title": "Sci-Fi",
  "url": "https://inkrediblebooks.com/categories/scifi",
  "meta": { "pages": 496 }
};

_movableInkPlugin.categoryViewed(properties);

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	String	The currency of the price. Defaults to USD. Introduced in v2.	-
products	List<Map<String, dynamic>>	A List of the products in an order. Product is a Map<String, dynamic>, requiring an id, and optionally a price, quantity, title, url and meta.	100 Items

final Map<String, dynamic> properties = {
  "id": "1",
  "revenue": "15.99",
  "currency": "USD",
  "products": [
    {
      "id": "1",
      "price": "15.99",
      "quantity": 1,
      "title": "Hyperion",
      "url": "https://inkrediblebooks.com/hyperion-dan-simmons",
      "meta": { "pages": 496 }
    }
  ]
};

_movableInkPlugin.orderCompleted(properties);

DaVinci Enabled - SDK v2

DaVinci will automatically receive the Order Completed event for DaVinci customers.

Note that the other Order events that DaVinci supports are NOT supported by the SDK such as Order Refund / Cancellation.

v2

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

Custom Defined Events

In addition to the pre-defined events we provide, you can log custom events tailored to your business specific requirements. This flexibility enables you to monitor and understand user interactions beyond what our pre-defined events offer.

This type of event has a custom name name, such as video_started, and optional parameters as the payload.

The name and properties of a custom event must first be defined on your companies account. Please reach out to your Movable Ink client experience team at MovableInk to get started with this.

_movableInkPlugin_.logEvent("video_started", {"title": "Cat Bloopers"})

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.