Tealium integration

This article describes how to configure Leanplum in your Tealium Universal Data Hub account.

Requirements

  • App ID
  • Client Key
  • API Version

Supported Actions

Action NameAudienceStreamEventStream
Set User Attributes
Send Message

Configure Settings

Go to the Tealium Connector Marketplace and add a new Leanplum connector. Read the Connector Overview article for general instructions on how to add a connector.
To configure the connector, follow these steps:

  1. In the Configure tab, provide a title for the connector instance.
  2. Provide additional notes about your implementation.

Action Settings: Parameters and Options

Click Next or go to the Actions tab. It's where you'll set up actions to trigger.
This section describes how to set up parameters and options for each action.

Parameters

  1. App ID (Required): A required parameter. The application ID. To find yours, select your app in the navigation column, and click Edit Apps. Then, under Keys, click Show.
  2. Client Key (Required): A required parameter. The Production key for your Leanplum App.
  3. API Version (Required): A required parameter. The version of the Leanplum API to use. At time of writing (December 2017), the most recent version is 1.0.6.
  4. User ID (Required): A required parameter. The current user ID. You can set this to an email address, or whatever you use at your company for user IDs. Leave it blank to use the device ID. For more info visit our selecting a user article.
  5. Create Disposition (Optional): An optional parameter. The policy that determines whether users are created by the API. Possible values are: (1) CreateIfNeeded creates a user with the given IDs if one does not already exist. (2) CreateNever requires that the user already exists, otherwise the API call is skipped and a warning will be returned. The default value for this method is CreateIfNeeded.
  6. Dev Mode (Optional): An optional parameter. Whether the user is in Development Mode, that is, the caller is a developer and not a user. This is important for reporting purposes. Please use either 'true' or 'false'. Default: false.
  7. User Attributes (Required): A required parameter. A map of user attributes as key-value pairs. Each key must be a string. Attributes are saved across sessions. Only supplied attributes will be updated (i.e., if you omit an existing attribute, it will be preserved). For example: {"gender":"F","age":21}.
  8. User Attribute Values to Add (Optional): An optional parameter. A map of values to add to existing user attribute sets. For example, supply {"Interests":"Sports"} to add Sports to the existing set of interests.

Action: sendMessage

Parameters

  1. App ID (Required): A required parameter. The application ID. To find yours, select your app in the navigation column, and click Edit Apps. Then, under Keys, click Show.
  2. Client Key (Required): A required parameter. The Production key for your Leanplum App.
  3. API Version (Required): A required parameter. The version of the Leanplum API to use. At time of writing (December 2017), the most recent version is 1.0.6.
  4. User ID (Required): A required parameter. The current user ID. You can set this to an email address, or whatever you use at your company for user IDs. Leave it blank to use the device ID. For more info visit our users and devices article
  5. Message ID (Required): A required parameter. The ID of the message, found in the URL when viewing a message. For example, www.leanplum.com/dashboard#/{APP_ID}/messaging/{MESSAGE_ID}.
  6. Dev Mode (Optional): An optional parameter. Whether the user is in Development Mode, that is, the caller is a developer and not a user. This is important for reporting purposes. Please use either 'true' or 'false'. Default: false.
  7. Device ID (Optional): An optional parameter. A unique ID for the device targeted by the call. You must provide a deviceID and/or a userID. For more info visit our users and devices article
  8. Create Disposition (Optional): An optional parameter. The policy that determines whether users are created by the API. Possible values are: (1) CreateIfNeeded creates a user with the given IDs if one does not already exist. (2) CreateNever requires that the user already exists, otherwise the API call is skipped and a warning will be returned. The default value for this method is CreateIfNeeded.
  9. Force (Optional): An optional parameter. Whether to send the message regardless of whether the user meets the targeting criteria. Please use either 'true' or 'false'. Default: false.
  10. Values (Optional): An optional parameter. A JSON object of key-value pairs to override Jinja values in the message.

Leanplum Documentation


Did this page help you?