Leanplum's user guides and developer documentation.

Leanplum Documentation

Leanplum's user guides, SDK setup, API docs, and more resources are here to help you get the most out of A/B testing, Campaigns, Messaging, and Analytics.

Actions basics

Everything you include in a campaign is called an action. Actions can be messages, A/B tests, or webhooks.

Choose a Channel

First, select a channel to get more template options and start editing your campaign's content.

available actions

Edit your action

Once you select your channel, you'll be able to choose a template to get started on your message content and other action settings. Select one of the links below for more details on editing a specific action.

Push notifications. Send a message to your users whether they are in your application or not. Users must have enabled push notifications and have a valid push token to receive these messages.

In-app messages. Send a message to users at a chosen place or time within the app. Leanplum offers a variety of in-app templates, including alerts, center popups, confirmations, surveys, interstitials, and rich in-app templates.

Email. Send a fully customizable email message to the user’s provided email address. This is a good way to reach users who haven’t opted in for push notifications. (Only available for clients with Email Messaging services.)

App inbox. Send messages to an inbox contained within your app. App inbox messages are a good way to ensure your users can return to the content you sent, whereas alerts and other types of messages might disappear after the first view.

Webhook. Send messages or other information to another service, such as an email provider. Webhooks allow Leanplum to give external applications real-time information.

[Variable] Change a variable value in your app. Make significant changes to your app’s experience without submitting changes to the App Store.


Variable changes are coming soon! (beta)

It is currently not possible to update variables in the campaign composer. Check back for updates.

App function. Sets a custom piece of code into action. Also sends deep links, App review requests, and other system prompts.

You can use one of our standard App Functions or add your own custom ones.

Sub-Delivery and Sub-Audience

After you edit the content of your action, you can decide when to send it using Sub-Delivery. You can also specify who should receive an action using Sub-Audience. These settings will always fall within the Delivery and Audience settings of your overall campaign. See Sub-Delivery and Sub-Audience for more.

Click Next after editing your action to move on to your Sub-Audience, or click the Sub-Audience and Sub-Delivery links at the top of the editor to alter these settings.

Add more actions with branches and chains

You can create complex, multi-action campaigns by branching and chaining messages in the preview window on the right side of the screen. See Add multiple actions for more instructions.

Name your actions

To edit an action's name, hover over it and click the pen icon. Type your new name, then click away or hit Enter.


Tip: Giving your actions unique names will help you identify the events and analytics related to those actions later on.

Updated 2 months ago

Actions basics

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.