Skip to main content

Documentation Index

Fetch the complete documentation index at: https://moengage-getz-tagging-workspace-status.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

WhatsApp templates facilitate streamlined communication by helping businesses curate predefined, personalized messages. You can send WhatsApp Messages using MoEngage and use the templates that are already approved or whitelisted (directly or by the WhatsApp Service Provider or BSP) by WhatsApp in the MoEngage Platform.
This feature enables you to improve business efficiency, establish automated notifications, foster better customer engagement across WhatsApp, and help enhance brand trust.

Use cases

  • Launching new products? Use the carousel WhatsApp template to showcase the exclusive collection.
  • Got a limited-time offer? Set a timer with the Limited Time Offer WhatsApp template, and let customers grab their deal before it’s over.

Add Templates to MoEngage

Ensure that you have access to all the approved WhatsApp templates before adding templates to MoEngage. You can access the templates from the BSP Dashboards.
To add your already approved/whitelisted WhatsApp templates in MoEngage, go to MoEngage Dashboard -> Settings -> WhatsApp -> Approved Templates. Click + Template in the UI. AddTemplates.png
MoEngage does not validate your templates when you save them. Hence, please ensure they match exactly to your whitelisted templates, or else your campaign may fail because of template mismatch.
Alternatively, you can create a WhatsApp template by performing the below-mentioned steps:
  1. Navigate to Settings > WhatsApp > + Template. WA new templates.png
  2. On the Templates page, in the settings section, fill in the fields as suggested below. Screenshot 2024-09-27 at 4.52.22 PM.png The following options are available in the settings section.
    FieldDescription
    NameEnter the template name exactly similar to what you have on the BSP side. The name can be up to 100 characters
    Service ProviderChoose the service provider from the dropdown (or your BSP) with which you want to send this templated message. Please know that WhatsApp templates are approved on the WABA level, which can belong to only 1 BSP. So select the BSP with which the template is compatible.
    Sender ProfileChoose the sender profile to with which this template is approved. You can select multiple sender profiles if they are from the same BSP and are under the same WABA.
    LanguageSelect the language for the template content. This value determines the language of your template. It should be similar to what you have on the BSP/WSP side.
    CategorySelect the category type from the dropdown. WhatsApp allows sending messages that belong to one of the following categories:
    • Marketing
    • Utility
    • Authentication
    Template TypeThis field is visible only if you have selected the Category field as Marketing. Select the template type from the dropdown menu.
    • The Carousel, Limited Time Offer, Coupon Code WhatsApp templates, and up to 10 buttons are supported only for GupShup , Karix & Infobip.
  3. On the Templates page, in the Content section, fill in the fields as suggested below.
As supported by WhatsApp, selective fields can be configured as: Static - Static fields are fixed on the Template level. For example, static images can be used to send the same image in all messages to target users across all campaigns where this template is used. Dynamic - Dynamic fields are flexible and can be configured during campaign creation. A dynamic image can be used to personalize for each campaign or each user in that campaign. Dynamic Link Tracking - Dynamic link tracking allows you to track clicks on buttons with Navigation as an action. This is available only for Navigation buttons and for Gupshup as a provider. f02bde24-3a02-4ba7-ab9d-6f8cc4517747.png

Headers

Headers are optional and can be of the following types:
  • Text (up to 60 characters, can include 1 placeholder)
  • Image
  • Video
  • Document
  • Location The non-text header can be static or dynamic. They can use a fixed image or document link or personalized image/document for every user. Dynamic fields will be available for configuration at the time of campaign creation. For more information, refer to Image Personalization. WATemplateHeader.png Here are supported media types, media formats, and file sizes that MoEngage supports:
Content-TypeSupported Format and file size
ImageThe supported image types are JPG, JPEG, PNG. The maximum file size is 5MB.
DocumentThe supported document type is PDF. The maximum document size is 5MB.
VideoThe supported file types are MP4, 3GPP. The maximum file size is 15MB.
  1. Once configured, select Save in the lower-right corner of the screen.

Template Management

To manage all your WhatsApp Templates, go to MoEngage Dashboard -> Settings -> WhatsApp -> Approved Templates. Once a template is added, you can manage your templates depending on if they are in use or not by a campaign.
Template UsageAllowed Template Actions
Template not being used inside any campaignView, Edit, Duplicate, Delete
Template being used inside any campaignView, Duplicate

Sync Templates from Vendors to MoEngage

MoEngage enables you to sync templates from configured partners to the MoEngage platform. Syncing templates will automatically retrieve all updated templates from the partner portals since the last updated time. To sync templates:
  1. Go to MoEngage Dashboard > Settings > WhatsApp > Approved templates.
  2. Click Sync Template in the top right of the Approved templates tab. Template sync.png
After the sync is complete, one of the following messages is displayed:
  • Sync successful: All templates from connectors are synced to MoEngage successfully. You can see the summary of successful changes and also view the templates based on last updated time.
  • Sync failure: Templates sync from connectors to MoEngage failed. You can see the reasons for unsuccessful sync.
  • Mixed sync results: Templates sync from connectors to MoEngage is partially successful. For templates that are synced successfully, you can see the summary of successful changes; for templates that failed to sync, you can see the reasons for failures.
The following is the list of statuses after template sync:
StatusDescriptionNext Possible Actions
CreatedThe template you created on the vendor portal is submitted for approval, but Meta is yet to approve it. Meta can approve or reject the template.You can create WhatsApp campaigns using this template.
ApprovedThe template you created on the vendor portal is approved by Meta.You can use the approved template to create WhatsApp campaigns.
RejectedThe template you created on the vendor portal is rejected by Meta.You cannot use the rejected template to create WhatsApp campaigns. When you edit a rejected template in MoEngage and save it, it will move to the Manually approved state. If the template is not exactly the same as the template on the vendor portal and you create WhatsApp campaigns using this template, the campaign creation will fail because of template mismatch. You must:
  1. Update the rejected template in the vendor portal and get the approval from Meta.
  2. Update the template in MoEngage with new content or Delete the template in MoEngage and sync again.
SuspendedAfter the initial sync of templates from the vendor portal to MoEngage, during subsequent sync:
  • If the content of a template on the vendor portal and MoEngage is same, we will update only the status. For example, a Manually approved template can move to Approved or an Approved template can move to Rejected.
  • If you have updated the content of a template on the vendor portal, we will mark it as Suspended because there is a difference of content between MoEngage and the vendor.
Click the ellipsis icon () and select View usage. The Active campaigns pop-up is displayed showing the campaigns created using this template.
  • If the template is not used in any campaign, delete the template in MoEngage and click Sync template again. MoEngage retrieves the latest content for it. To delete a suspended template:
    1. Stop the existing campaigns.
    2. Click the ellipsis icon () and select Delete.
  • If the template is used in any campaign(s), update the template in MoEngage and click Sync template again. To update content:
    1. If a template is used in any campaign, edit the template in MoEngage and add the content manually to properly match the content on the vendor portal and save the template.
    2. If you have added or removed any additional variables, ensure to add the details in campaigns.
    3. To verify if the template content matches the content on partners portal, click Sync template.
Manually approvedWhen you edit a template in MoEngage and save it, it will move to the Manually approved state. If the template is not exactly the same as the template on the vendor portal and you create WhatsApp campaigns using this template, the campaign creation will fail because of template mismatch.You must update the template in MoEngage to ensure that the content matches the content in the template in the vendor portal exactly.
  • Currently, you can sync templates from Gupshup and Karix. It might take up to 15 mins to complete the sync.
  • For every sync, it will be synced for templates updated in the last 2 days.
For more information about issues and resolutions associated to WhatsApp campaign feature, see Common Errors in WhatsApp Campaigns.

Manage WhatsApp Template Suspension Alerts

When syncing WhatsApp templates from your vendor to MoEngage, templates can carry various statuses: Created, Approved, Rejected, or Suspended. A template enters a Suspended status when there is a content mismatch between the vendor dashboard and MoEngage. To ensure your communication remains uninterrupted, MoEngage provides real-time alerts to notify you the moment a template suspension occurs.

Why Set Up Suspension Alerts?

Previously, users might not have been aware when a template moved to a suspended state, leading to failed campaigns. With these alerts, you can:
  • Identify Impacted Campaigns: Immediately see which active campaigns are using the suspended template.
  • Minimize Downtime: Take swift action to fix the template at the vendor level or swap it in your MoEngage campaigns.
  • Receive Multi-Channel Notifications: Get alerts where your team already works (Slack, Teams, Email, or Webhooks).

Configure Suspension Alerts

To create an alert for WhatsApp template suspensions:
  1. On the left navigation menu in the MoEngage dashboard, go to Settings > Reports and Alerts > Alert Management.
  2. On the Alert management page, click + Create alert.
  3. On the Create alert page, enter the following details:
    • Alert name: Provide a name for the alert.
    • Create Alerts On: Select WhatsApp Template Suspension from the list.
    • Send Alert On: Select the notification channels through which the alert should be sent.
    • Add alert destination: Configure external destinations to receive alerts via Slack, MS Teams, or a custom Webhook.
    • Members: Add the members who should receive this alert.
  4. Click Create to create the alert.
MoEngage now monitors all template syncs and triggers a notification if any template status changes to Suspended.

Understanding the Alert Notification

When a template is suspended, the alert provides the following essential information:
  • Template Details: Includes Template Name, Language, and Sender/Provider name.
  • Timestamp: The exact time of suspension, displayed in your App Time Zone (e.g., New York Time).
  • Active Campaign Visibility: A list of all campaigns currently utilizing the suspended template. This includes:
    • One-time Scheduled campaigns
    • Periodic campaigns
    • Event-triggered campaigns
    • Flows
Campaigns sent as soon as possible after creation will not be listed, as the alert focuses on currently active/future-dated impacts.

Handling Template Failures

If you attempt to send a campaign using a template that has been suspended, the campaign logs will reflect a failure reason: Failed to send due to template was suspended. If you encounter this error within a campaign, MoEngage provides a direct shortcut from the campaign interface to Create an Alert, ensuring you are notified of future occurrences for that specific template.

Next Step

After your templates are approved and synced, you can create your first WhatsApp campaign in MoEngage. For more information, refer to Create a WhatsApp Campaign.