To create an Alert:
- Navigate to Alerts.
- Click +Create Alert at the top right corner.
Configure Alert
To configure the alert:
- Alert Details: Add details to describe the Alert
- Content: Design the message for all selected channels
- Publish: Test and publish the alert
Alert Details
Add details to describe the Alert:
-
-
- Specify an Alert Name This field is used to identify the Alert and is mandatory. This field can contain a minimum of 5 characters and a maximum of 256 characters.
-
Describe the alert in Alert Description
This field is used to describe the purpose of the Alert:-
-
-
Tags
Select the predefined tags or add new tags to identify your alert. This dropdown contains tags that can add context to your alerts. These tags can describe the purpose of the alert, such as transaction OTP, order confirmation, and so on. Once added, tags allow you to filter Alerts in the All Alerts section. For more information about, refer to Tags. -
Teams
This field is used to select the Team associated with this Alert from the list of Teams. This field is enabled during Alert creation if your organization has “Teams” enabled. For more information, refer to Teams in MoEngage
-
Tags
-
-
-
Configure relevant channels
-
-
- SMS
- Push
-
info Note
These channels need to be configured before Alert Creation. Please refer to SMS Settings, Email Settings, and Push Settings for configuring these channels.
Choose the channels on which the Alert has to be sent, and the content for the chosen channels can be defined in the next step (content creation) of Alert creation. It is mandatory to select at least one channel for Alert Creation. If more than one channel is selected, the content for both of them must be defined.
-
-
Set Channel Sending Order(Channel Fallback)
If you choose more than one channel for Alert creation, you can configure if the Alerts should be sent parallelly or sequentially. When more than one channel is selected, the following channel-sending order options are available:
-
- In parallel - you can send Alerts parallelly for only two channels.
-
In sequence (with Fallback) - You can specify the Default, first, and second Fallback channels to be used when there is a failure to send using the Default channel. Channel fallbacks are employed in the case where:
-
- there is an error in the request payload for the default or first fallback channel. For example, when the recipient details or personalization attributes are not present in the request payload for the channel
- when the request returns a 4xx or 5xx error when submitted to the vendor for the particular channel. For example, invalid authorization details would result in a 401 error returned by the vendor, and this would be considered a failed-to-send error for the channel for which the delivery is being attempted.
- vendor rejections for requests for channels would also lead to MoEngage using the fallback channel to send the Alert. For example, if your credit limit is exhausted for the vendor account, the vendor could reject the request to send the Alert. In such a case, MoEngage would use the fallback configured to send the Alert.
For example, if the default channel were Push, the first fallback SMS and the second fallback Email and an Alert is being sent to a customer. If there is a failure in sending the Push (say if the user does not have an active Push token), then the Alert will be attempted using the SMS channel. If there is an issue in sending using the SMS channel, the Email channel will be tried next.
-
-
Create Content
This section defines the content for the Alerts to be sent.
You can create the content for the SMS campaign using the following options:
- A blank template where you fill in the required details for all the fields.
- A custom template that pre-populates the data from the templates uploaded to MoEngage using the SMS Template APIs.
Create Content using a Blank template
Choose the blank template and follow these steps to create the content for the SMS campaign:
The following fields are available in the SMS content creation section for Alerts.
-
SMS Sender
Choose the SMS connector for sending the SMS Alert using the SMS Sender dropdown. This dropdown displays the list of configured SMS connectors.
-
Template ID
This field is mandatory if the SMS connector chosen falls under DLT regulations (India region).
For more information, refer to DLT regulations. -
Message
This field will contain the message that would be sent to the user. You can personalize your message by clicking the Text personalization button to the right of the message editor. Refer to Personalize your Alert for details.
-
Shorten URL and Track URL
This section displays URLs present in the message body. For selected URL(s), the URLs are shortened using the MoE domain(<to add MoE domain>) and sent to users.
info Note
Click tracking would only be enabled for URLs where Shorten & Track URL is enabled.
Create Content Using Custom Templates
You can choose one of the uploaded templates in this section to send Alerts using it. For more information, refer to SMS Custom Templates.
Add a Locale
To localize the Alert in various languages, click +Locale at the top right corner of the content creation step. You will have the option to add a new locale or add an existing locale to the campaign. You can copy the existing content from the default locale or create a new message altogether for the locale added. For more information, refer to Localize campaign message.
Preview your SMS
The preview of how your SMS Alert will look on the user’s device is shown on the right of the content creation section, as illustrated below.
Testing your SMS Content
The test Message section will help you test the message content by sending a test message. This will help you ensure the message is conveyed in the desired manner. This step is optional and lets you test the content of your Alert by sending it to a specified mobile number.
To Test the SMS Content, enter the mobile number in the format <country code><Mobile number>. For example, the recipient's mobile number should be similar to +14083636XX or 1408363XX
The test results are populated in the Test alert stats screen below.info Note
If you have personalization attributes in your content, you can see how they are rendered by sending a test from the Test Request Details in Step 3 using an API. The test Message section will not render dynamic values for personalization attributes. For example, {{user}} would be sent as {{user}} for the test message, but in the Test and Live Alert, these will be replaced with the value for this attribute passed in the channel payload of the request.
In the case of failure, the Test alert stats screen contains the failure reason as shown below.info Note
The Test Message option available here is different from the Test Request Details present in the Publish step of Alert creation. The Test Message section helps you test your content, while the Test Request Details will send a test request with the payload information to the API and show you the API response.
The following options are available in the Email content creation section for Alerts. Choose one of the options to create the content for your Email Alert.
Drag and Drop Editor
The Drag and Drop editor lets you create an email template for your Alert using MoEngage’s pre-built templates. You can customize the templates as per your need.
Custom HTML Editor
The Custom HTML Editor allows you to work with HTML to create the Email Template. You can either type or paste the HTML content or upload the HTML file(Zip file) and edit it using the editor.
My Saved Templates
The Saved Templates section lets you load one of the saved templates and edit it as per your need.
After choosing one of these template options, on the next screen, you can enter the sender details and attachment details and edit or add the message content.
Sender Details
This section contains the following fields:
- Subject
- Email Connector
- Sender Name
- From email address
- Reply to email address
All the fields in this section are mandatory.
Attachment Details
You can add attachments to an Email Alert by clicking the Attachments tab (available next to the Sender Details Tab) and add attachments using one of the following options:
- Local file - This option lets you upload files from your local drive. You can drag and drop the file in the Upload your file(s) section or click the Upload from computer option to browse the file from your computer and upload it.
-
URL - This option lets you specify a URL from where the attachment can be downloaded and added to the alert. You can specify a single URL to be used for every user or personalize it by adding the URL inside the personalization tag {{}}. For example, to personalize the attachment URL, you can specify it as https://{{url}} in the Upload your file(s) field. You will have to pass this parameter in the payload when sending the request to the Inform API.
info Note
- Individual attachments should be less than 6 MB, and the total size of the attachments should be less than 10 MB.
- You can attach up to 10 files.
-
The URL should start with https and end with a valid extension. The following extensions are not allowed: .dmg, .exe, .xls, .ddl, .class, .obj, .int, .gnt, .o, .so, .lbr, and .net
- The time to send for personalized attachment would be the sum of Inform’s Time to Send SLA and the time taken to download the file from the specified URL.
Fill in the required details and move to the Template editor section below to edit the email content.
You can personalize your email using the Text personalization button available at the top right corner of the editor. Refer to Personalize your Alert for details.Create Content Using Custom Templates
You can choose one of the uploaded templates in this section to send Alerts using it. For more information, refer to Email Custom Templates.
Add a Locale
To localize the Alert in various languages, click +Locale at the top right corner of the content creation step. You will have the option to add a new locale or add an existing locale to the campaign. You can copy the existing content from the default locale or create a new message altogether for the locale added. For more information, refer to Localize campaign message.
Preview your Email
You can preview your email by clicking the Preview button in the top right corner of the template editor. The following preview options are available:
- Desktop
- Mobile
Testing Email Alert Content
The Test Message section will help you review the email content by sending a test message. This will help you ensure that the message is conveyed in the desired manner. This step is optional and lets you test the content of your Alert by sending it to a specified email id.
To test the Email content, add the email id and click on Test.
When the test is successful, the following success message appears.
When the test fails, you get the error displayed, as shown below.
If you have personalization attributes in your content, you can see how they are rendered by sending a test from the Test Request Details in Step 3 using an API. The Test Message section will not render dynamic values for personalization attributes.You can create the content for the Push campaign using the following options:
- Default Templates
- Custom Templates uploaded to MoEngage using the Push Template APIs
Default Templates
The following template options are available in the Push content creation section for Alerts:
- Basic notification
- Stylized basic
- Simple image carousel
Choose one of the templates to create the content for your Push Alert. For more information, refer to Push Templates. You can personalize your notification using the Text Personalization button available at the top right corner of the editor. Refer to Personalize your Alert for details.
Custom Templates
You can choose one of the uploaded templates in this section to send Alerts using it. For more information, refer to Push Custom Templates.
Add a Locale
To localize the Alert in various languages, click +Locale at the top right corner of the content creation step. You will have the option to add a new locale or add an existing locale to the campaign. You can copy the existing content from the default locale or create a new message altogether for the locale added. For more information, refer to Localize campaign message.
Advanced Settings
The following options are available in this section:
Expiration Settings - let you specify an expiry value for the push notification. This section contains information about when to stop sending push notifications (after a specific time duration mentioned) for the iOS and Android platforms. Set the expiry duration in Expire notifications after. Priority - choose this option for time-critical notifications. The following options are available:
-
- Android - Click Send at priority to send the campaign as a priority notification.
- iOS - Select from the Interruption Level (Active, Passive, Time-Sensitive, and Critical) from the drop-down to set the priority of the notification. Set the Relevance Score for setting the importance of the notification. For more information, refer to Notifications in iOS 15.
Publish
You can test your Alert before publishing to check if the integration with the API is working fine and to view the actual SMS and Email as they will be received by your users. For more information, refer to Test your Alert.
To publish your Alert, click on Publish at the bottom right corner of the Publish page of Alert Creation. This will publish your Alert and generate an Alert ID that will be used to uniquely identify your Alert.
You will now be taken to the Alert Info page, where you can see the request details and message previews. You can also switch to the Analytics and Logs sections.
Now that your Alert is published, you can use it to send Alerts to your users using the Inform Service API.
info Note
The following checks will not be performed for Alerts on any channel: Delivery Controls (Frequency Capping and Do Not Disturb), Unsubscribe (only email), Complaints (only email), Bounces (only email), Opt-in preference (only SMS).
-