Transactional Messages
Transactional messages are user-level notifications sent via backend / API. They are usually immediate and context-specific.
Use them for messages tied to a user action or a system event. Common examples:
order confirmation
shipping update
appointment reminder
password reset
Path: Messages > Transactional > Create New Transactional Message
Quick Steps Guideline
Create the transactional template in the panel.
Set a Message Key to identify it in API calls.
Add Message Parameters for personalization (profile attributes).
Decide if the API can override message settings.
Configure limits and time restrictions if needed.
Use Sample Request to test before production use.
Setup & What
The only extra step for Transactional Messages is API & Config. The other steps match the standard message flow.
API & Config
This step defines how your backend will send the message. It also defines what can be customized per API call.
Message Key
A unique identifier for this transactional message. Use it to reference the message in API calls and reporting.
Message Parameters
Parameters are values you inject into the message content. They typically map to profile attributes or payload fields. Example: user name, order number, membership tier.
Allow API to override any of message settings
If enabled, the API caller can override settings at send time. This includes content and delivery-related settings.
Enable this when you want the backend to control settings dynamically. Keep it disabled when you want strict template governance in the panel.
Sample Request
Use Sample Request to test the message with a real API call. This helps verify payload and personalization before production.
Sample Response
Sample Response shows whether the request succeeded. Use it to debug errors and validate delivery.
Limits and time restrictions
Use limits to control volume. Use time restrictions to control delivery windows.
Ignore User Message Limits: bypass user-level message limits.
Total Limit: cap the total number of sends for this transactional message.
Limit: cap how often the same user can receive the message in a period.
Push Time Restriction: restrict sending to specific hours/days.
Last updated
Was this helpful?