MoEngage acts as a central hub for your data, to which you can plug and connect any system for the duration of your choice. Connectors allow you to target users across all communication channels. The Connector campaign from MoEngage enables you to execute a variety of use cases such as:
- Retrieving real-time data from MoEngage
- Passing data to other-owned or third-party analytics systems
To create a Connector campaign:
- Navigate to the MoEngage Dashboard and select Engage > Campaigns from the left navigation. The All campaigns page is displayed.
- At the top right corner, click + Create campaign.
- Under Connectors, click Custom and select one of the following campaign delivery types:
- One Time
- Periodic
- Event Triggered
For more information about delivery types, refer to Delivery Types.
Steps to Create a Connector Campaign
The following are the steps to create a Connector campaign:
- Target users: Define the target audience for the campaign.
- Content: Define the content of the Connector campaign to be sent.
- Schedule and Goals: Define the campaign's delivery schedule and goals.
Step 1: Target Users
This section contains the following:
Campaign Details
The campaign details section contains the following fields:
|
This section contains the event criteria that (when satisfied) will trigger the Connector campaign notification. To define the trigger condition, do the following under Trigger criteria:
- In the IF user section,
- In the Select an event drop-down list, select a user action that needs to be performed to trigger the campaign. This is the primary filter condition.
- Click + Attribute to add attributes to the filter. (This is optional)
- Click + ADD FILTER to add another filter with the primary filter. (This is optional)
- In the THEN trigger the message section,
- Select Immediately to send the campaign within the next 30 to 60 seconds.
You can send the campaign with only the If condition. - Select With Delay and provide the following details to define the timeframe and the event criteria to be fulfilled to send the campaign:
- Enter the number and select the minutes, hours, or days.
- Select Before or After the time.
- Select the action to be performed by the user in the drop-down list for the if condition. The user must perform the actions added within the time specified in the delay criteria after performing the first action.
- Select Immediately to send the campaign within the next 30 to 60 seconds.
When to use event-triggered Connector campaigns?
-
Configuration without an event property:
Set an event-triggered campaign to target users when there is no event property. For example, when the users abandon the cart and do not complete the purchase within the next 45 mins. The trigger condition for this scenario would be:
IF the user has executed the event 'Added to Cart' AND has not executed the event 'Purchase'.
Select the user or derived event in the IF condition and enter the event attributes. You can enter additional event attributes as well.
-
Configuration with an event property:
With event triggers, you can trigger the Connector campaign notification for specified values of the event attribute in your IF event. For instance, if you want to remind users who have booked a flight, 2 hours before the flight time, you can create a trigger on the Flight Booked event using the event property Flight Time and set the notification to be sent 2 hours before the flight time.
-
Other examples:
- Send discounts or reminders to your subscribers before the subscription expiry
- Send a communication before the flash sale to customers who have registered for it
- Send a reminder before customers' travel date or time
- Send a message to cross-sell hotels, experiences, local transport, restaurant bookings
- Send a reminder to customers to refill consumables before they end
Select Audience
This section contains segmentation filters that help you choose the target audience for your campaign. The following options are available:
This filter option allows you to send the campaign to all the app users. When you use this option, you cannot add multiple filters.
This filter option allows you to target the users based on user properties such as first seen, last seen, city, and so on. Click the User property tab and do the following:
- Select the desired attribute in the drop-down list. This enables the filters based on the attributes selected. For example, attributes that are numbers can have filter conditions such as 'is equal to', 'is not equal to', 'is between', and so on, while string attributes have different filters.
- Enter the filter value(s) to create the desired user segment.
- Click + Nested Filter to add a filter to create nested AND or OR conditions. (This is optional)
For more information, refer to Create Segments.
This filter option allows you to target the users based on the behavior of the user or event, such as app/site opened, viewed product, and so on. Click User Behavior and do the following:
- Select the execution condition and the desired user activity (event).
- Enter the event frequency and time duration for the event execution.
- Click + Attributes and add an event attribute with a filter condition.
- Enter the filter value(s) to create a rule.
-
Use the + Aggregation button to add the aggregation functionality. For more information, refer to Aggregation Operations.
-
Click + Nested Filter to add a filter to create nested AND or OR conditions. (This is optional)
For more information, refer to Create Segments.
This filter option allows you to target groups of users created based on the user performing an action with a specific attribute value. For more information, refer to User Affinity. Click User Affinity and do the following:
- Select the desired user event or attribute.
- Select the user affinity parameter from the following:
- Predominantly: Select affinity attribute with a filter condition and provide the affinity values.
- For a minimum of: Select affinity attribute with a filter condition and provide the affinity values.
- Most no. of times: Enter a value or use the arrows to provide the top percentage of users.
- Least no. of times: Enter a value or use the arrows to provide the bottom percentage of users.
- Enter or use the arrows to provide the time duration for the event execution.
- Click + Attribute to add more attributes to the filter.
- Click + Nested Filter to add a filter to create nested AND or OR conditions. (This is optional)
For more information, refer to Create Segments.
This filter option allows you to select a custom segment as the target audience.
- Select a custom segment as the target audience from the list of custom segments available.
- Click + Nested Filter to add a filter to create nested AND or OR conditions. (This is optional)
For more information, refer to Custom Segments.
After selecting the filter criteria, you can do the following as well:
-
Create Multiple Filters: You can create and combine multiple user property rules, user activity rules, and custom segment rules to create a complex user segment using this option.
- Click + Filter.
- Click AND or OR.
- Select the attribute or event and define the filter conditions.
- Exclude Users: Select this checkbox to define the filter criteria for users to be excluded from the campaign.
- Reset Filters: Click this option to reset the segmentation filters.
- Show Count: Click this button to display the total number of users who are currently in the configured segment.
Control Group
This section contains information about control groups for the campaign. To exclude users from the control groups, do the following:
|
In the Control groups section, enable the Global control group toggle to exclude the users from the campaign's target segment. For more information, refer to Control Group. |
Click Next or use the tabs on the top of the create campaign navigation to move to Step 2.
Step 2: Content
Configure Webhook URL or target connector URL. You can use the following methods:
- GET
- POST
- PUT
- DELETE
Common for GET, POST, PUT, and DELETE
| Field | Description |
|---|---|
| Webhook URL | Enter the URL for the webhook to which you want to send the data. |
| URL Parameters |
Enter the parameters for the API. If the URL has the parameters, the parameters are autofilled in the URL parameters field. Click + KV pair to add another URL parameters. |
| Headers |
Add the headers for the webhook. Click + KV pair to add another header. |
POST, PUT, and DELETE Body Type
Configure the Body for your requests using the following options:
Create the body based on the form-encoded serialization for the webhook. Click + KV pair to add more form-encoded body.
Create the body using JSON format. Click + KV pair to add more JSON content.
Create the body using the raw text format.
Personalization
You can also use personalized parameters using the @ symbol. You can use the tracked user attributes to personalize your connector requests. Use personalization to send an SMS to a user-specific mobile number or send user-specific data to a third-party system using MoEngage connectors.
Enable Authorization Settings
If your connector request involves a basic non-changing access token, you can simply add those as a key-value pair in the header.
If your connector request involves an OAuth 2.0 authentication, perform the following steps:
- Turn on the Enable authorization settings toggle.
- From the Select authorization setting drop-down list, select an OAuth configuration.
info Information
You can see the OAuth settings configured in the MoEngage system at Settings > Advanced settings > Authorization configuration. For more information, refer to OAuth 2.0.
You must select a healthy OAuth setting, which is in "Active" status. If you select an OAuth setting in "Failed" status, you cannot create a Connector campaign.
- The Key field is populated as "Authorization" by default.
- In the Prefix field, enter a prefix. You can enter the name of a prefix added in the selected OAuth configuration. You can also override those prefixes and create your own prefix.
- In the Reattempt error codes field, enter error codes to initiate a reattempt in case of a failed response. For example, use the error code "400" for the expired error code to inform MoEngage to reattempt creating a Connector campaign.
Test campaigns enable previewing the campaign on a test device to ensure that your notification is conveyed in the manner that you desire.
You can test the campaign you created by selecting any of the following options and providing the value for the attribute chosen for your test user:
- Unique ID
- Email ID
- Mobile Number
- Google Advertising Identifier
- iOS Identifier For Advertising
- Device Push Token
- Custom Segment
Click Next or use the tabs on the top of the create campaign navigation to move to Step 3.
Step 3: Schedule and Goals
This section contains the following:
- Delivery Schedule: Choose when the campaign should be delivered to your users and the periodicity of delivery.
- Conversion Goals: Choose the conversion goals and revenue metrics to be tracked for the campaign.
- Delivery Controls: Choose the advanced delivery control options such as throttling, frequency capping, and expiration settings for the notification.
Delivery Schedule
Choose this option to send the campaign immediately to the target users.
Choose this option to send the campaign at the specified time, time zone, or predicted time.
This section helps you send the campaign on a specific date and time, and it contains the following fields:
- Campaign time zone: the timezone in which the campaign should be sent.
- Start date: the date on which the campaign should be sent.
- Send time: the time at which the campaign should be sent. Select am or pm depending on when the time of day at which the campaign should be sent.
- Campaign time zone: the timezone in which the campaign should be sent.
- Start date: the date on which the campaign should be sent.
- Send time: the time at which the campaign should be sent. Select am or pm depending on when the time of day at which the campaign should be sent.
- Periodic: the periodicity of the campaign. You can choose from the following options available:
| Periodicity | Description |
|---|---|
| Daily | Repeat every: This option allows you to specify the number of days after which the campaign should be repeated. |
| Weekly |
Repeat every: This option allows you to specify the number of weeks for which the campaign should be repeated. Repeat on: This option allows you to specify the day(s) of the week on which the campaign should be sent (For example, if you wish to send the campaign every Monday, Wednesday, and Friday, select these days in this option). |
| Monthly |
Repeat every: This option allows you to specify the number of months for which the campaign should be repeated. Repeat on: This option allows you do the following:
|
-
Ends: the date on which the campaign should end. The following options are available:
-
- Never: the campaign runs daily.
- On: the campaign ends on the end date specified in the End Date field.
- After: the campaign ends after the number of occurrences specified in the occurrences field.
-
- Campaign time zone: the timezone in which the campaign should be sent.
- Start date: the date on which the campaign should be sent.
- Send time: the time at which the campaign should be sent. Select am or pm depending on when the time of day at which the campaign should be sent.
- End date: the date on which the campaign should be stopped.
- End time: the time at which the campaign should be stopped. Select am or pm depending on when the time of day at which the campaign should be stopped.
When will event-triggered campaigns be sent?
The campaign will be sent only when:
- The event property or attribute, which is used to create these type of triggers (such as flight_time in previous example), is in a valid date-time format. If it is not in date-time format, the string should have data in one of the supported formats. If the selected attributes do not contain data in any of these formats, the campaigns are not sent to the users.
- The date or time value from the attribute is greater than the time at which the trigger condition is fulfilled.
- The date or time value from the attribute is less than 30 Days + the time at which the trigger condition is fulfilled. For example, if your trigger condition is fulfilled at date D, the notification is sent only when the attribute value is less than D+30.
- The intelligent delay optimization (With Delay) does not work for campaigns sent on relative timing.
Conversion Goals
You can add conversion goals to track the business metrics for your campaigns. You can track a maximum of five conversion goals. You can choose any app event as a conversion goal activity and set more than one conversion goal. The first goal will be treated as a primary goal.
For example, if you want to track the number of customers who have purchased an iPhone after your campaign was sent. (Event: Purchase event, Product: iPhone). Your conversion goal setup might be similar to the following image:
With multiple conversion goals, you can track more than one business metric or visualize a funnel for your user actions. For example, if you want to check the following, you can do so with multiple conversion goals.
- How many users have viewed the product page?
- How many of them added that product to the cart?
- How many of them made a successful order?
|
With MoEngage, you can track the revenue generated by your campaigns. For example, you can track the revenue generated by your product after sending a communication. To track revenue performance, enable the Revenue performance toggle for the conversion goal for which you want to track the revenue. In the example here, to track revenue for orderSuccessful events, you must enable the Revenue performance toggle. |
| After choosing the goal, you can select the numeric attribute that captures the order's total monetary value. In this example, cartValue contains the total order value. You can choose the currency in which your monetary value is being reported. |
| Set Attribution window: You can set an attribution window (a time period or window that is calculated since the user has received the campaign, for which you want to attribute the conversion goals to a specific campaign.) By default, it is set for 36 hours. |
Remove Duplicate Users
| info |
Information Applicable to One Time and Periodic campaigns only. |
Select the user attributes using which you can delete the duplicate users.
Delivery Controls
This section contains the following options:
- Ignore frequency capping: Enable this toggle to ignore the frequency capping limit for this Connector campaign. For more information, refer to Frequency Capping.
- Count for the frequency capping: Enable this toggle if you want this connector to be counted for frequency capping limit.
-
Request limit: Set the request limit to send the Connector campaign notifications. The maximum throughput is 200000 requests per minute.
Note: If the estimated time to send the campaign exceeds 4 hours, MoEngage automatically increases the requests per minute to finish sending in 4 hours. If multiple campaigns are running in parallel, campaigns might be delayed.
This section contains the following options:
|