Getting Started
WhatsApp Template
A WhatsApp Template configures outgoing WhatsApp messaging rules by binding an event trigger to a pre-approved WhatsApp template ID on integration provider services (such as AWS WhatsApp). When linked to a Notification rule, the platform resolves runtime variables for message headers, body components, and footers before handing off dispatch to WhatsApp gateways.
How it works
- Configure provider integration — select the target
integrationProvider(e.g.aws_whatsapp) and assign the associatedintegrationId. - Bind WhatsApp template ID — specify the approved
whatsAppTemplateIdregistered in your WhatsApp Business account. - Map template variables — the platform automatically maintains
whatsAppTemplateVariablesJSON mappings forHEADER,BODY, andFOOTERdynamic components. - Attach to notification rules — link the WhatsApp template to an active Notification rule with
templateType: whatsapp_templateto automate event-driven messaging.
Fields
Basic information
| Field | Type | Required | Max length | Description |
|---|---|---|---|---|
name | string | ✅ | 256 | Unique name of the WhatsApp template |
description | string | ❌ | 1 024 | A brief description of the WhatsApp template |
sampleEventCode | enum | ✅ | 64 | Sample event code used to load mock payload context |
status | enum | ✅ | — | draft · live · paused |
Integration & template mapping
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
integrationProvider | enum | ✅ | — | The WhatsApp integration service provider (aws_whatsapp). |
integrationId | UUID | Conditionally | — | Identifier of the linked WhatsApp provider integration record. Required when integrationProvider is set. |
whatsAppTemplateId | string | Conditionally | — | Identifier of the registered/approved WhatsApp template ID. Required when integrationId is set. |
whatsAppTemplateVariables | JSON | Read-only | — | System-managed variable parameter mappings for WhatsApp HEADER, BODY, and FOOTER blocks. |
Event codes
The sampleEventCode field maps event structures for WhatsApp notifications across:
- Streak Events:
streak_progress_broken·streak_progress_to_be_broken·streak_progress_completed·streak_progress_milestone_completed·streak_progress_non_milestone_completed·streak_progress_in_progress - Challenge Events:
challenge_progress_failed·challenge_progress_to_be_failed·challenge_progress_completed·challenge_progress_milestone_completed·challenge_progress_in_progress - Mission Events:
mission_progress_failed·mission_progress_to_be_failed·mission_progress_completed·mission_progress_milestone_completed·mission_progress_in_progress - Reward Unlocked Events:
streak_reward_unlocked_on_milestone_completion·challenge_reward_unlocked_on_milestone_completion·mission_reward_unlocked_on_completion·mission_reward_unlocked_on_milestone_completion
Real-world examples
🟢 WhatsApp — Streak Milestone WhatsApp Notification
Configuring a WhatsApp template mapping for AWS WhatsApp integration:
Code
Access & permissions
| Caller | Allowed operations | Notes |
|---|---|---|
| Admin | CREATE · GET · LIST · UPDATE · DELETE | Full management access |
| End user | (none) | No access |
| Guest user | (none) | No access |
Related resources
| Resource | Description |
|---|---|
| Notification | Active notification rules linking events to WhatsApp templates |
| Notification Log | Delivery audit trail for WhatsApp dispatches |
| Member | WhatsApp message recipient record |
API reference
See the API Reference for full schemas and interactive examples for:
GET /schema/whatsapp_template/record— list WhatsApp templatesPOST /schema/whatsapp_template/record— create a WhatsApp templateGET /schema/whatsapp_template/record/{id}— get a WhatsApp template by IDPATCH /schema/whatsapp_template/record/{id}— update a WhatsApp templateDELETE /schema/whatsapp_template/record/{id}— delete a WhatsApp template
Last modified on