Configuring your campaign

This document will teach you how to configure your campaign on the MobiPay portal.

In order to complete Web Opt-In for Kenya, you'll need to configure your campaign on our MobiPay Portal.

To start you need to modify or create your campaign here.

Alternatively navigate to our Subscription Portal and click the Manage Campaigns button.

Click Edit to modify your campaign, or you can click the Create button to create your campaign.

Configuring your Content Delivery / Billing Frequencies

In our Portal, you have complete customization over your content delivery and billing frequencies.

This allows you to configure when you bill your users for access to your content and at what price.

Opt-In Configuration

Is an important part of your campaign's overall configuration as it keeps track of the subscriptions through our system.

Upon working with Mobivate you will receive a unique keyword or multiple keywords depending on which flows you intend to use. These must be entered here and will look like the following:

mv-1000000001200 OR secured=mv-1000000001200

To get your unique keywords, please contact your account manager.

Event Actions

This section is used to configure your free welcome messages to your customer alongside the technical configuration of your callbacks.

In the Free Welcome Message and Free Pause Message sections, you can dynamically set messages that your users will receive for Subscribing and Unsubscribing to your service. These can also be toggled on and off using the tickboxes.

Receiving callbacks in your endpoints

Successful subscription callbacks

To configure your campaign to post successful subscription callbacks, you will need to include the rule: On Subscription Hit URL under your event actions.

Example request

https://<hostname>/callbacks/ke/safaricom/?action=subscribed&user=%(MSISDN)&keyword=%(KEYWORD)&service=%(SERVICE)

This example request will send the following parameters to your configured endpoint: action=subscribed, user=msisdn, keyword=keyword and service=service.

Successful unsubscription callbacks

To configure your campaign to post successful subscription callbacks, you will need to include the rule: On Pause (user sent STOP, subscription changed to Inactive) Hit URL under your event actions.

Example request

https://<hostname>/callbacks/ke/safaricom/?action=unsubscribed&user=%(MSISDN)&keyword=%(KEYWORD)&service=%(SERVICE)

This example request will send the following parameters to your configured endpoint: action=unsubscribed, user=msisdn, keyword=keyword and service=service.

Successful billed callbacks

To configure your campaign to post successful subscription callbacks, you will need to include the rule: On every positive DLRs hit url under your event actions.

Example request

https://<hostname>/callbacks/ke/safaricom/?action=unsubscribed&user=%(MSISDN)&keyword=%(KEYWORD)&service=%(SERVICE)&cost=%(COST)

This example request will send the following parameters to your configured endpoint: action=unsubscribed, user=msisdn, keyword=keyword, service=service and cost=cost.

To differentiate between billing requests and re-billing requests you can check the cost field as this will be set at different values.

To understand callback parameters and to see all available parameters, read our guide here.

Last updated