Our help articles and product guides are moving to a new home at docs.xtremepush.com

Articles in this section

How do I use Template Campaigns triggered/executed via API for Transactional SMS or Email messages?

Avatar
Ops Support
  • Updated
Follow

If you haven't already first review the general overview of template campaigns that can be triggered using the campaign execute method:

You will also find more details on how to setup API triggered campaigns with message content on the platform here:


The principles are the same for SMS and email. First you create your template campaign as outlined in the docs with necessary placeholders for dynamically changing content. You need to have a transactional template on the platform with placeholders for your variable params. To illustrate how this is used below is a classic transactional example of sending a gate update to an airline customer via an SMS message.

 
Screen_Shot_2018-08-04_at_00.10.23.png
In this example you would then use the execute method to trigger the campaign when gate information becomes available on the backend. Token and campaign id are used to target the right campaign in your project, and the params are set for the flight information (flight_number, time and gate_number). And finally to target users who are checked in for the flight we are adding a condition to target users who are on the list for the flight by targeting by user_id and providing an array of customer ids to target. 
URL = "https://external-api.xtremepush.com/api/external/execute/campaign"
POST_DATA ={"apptoken":"APP_TOKEN", "id":"CAMPAIGN_ID",
       "params":{"flight_number": "EI105", "time":"10:30", "gate_number": "B100" },
       "target_by":"user_id", "target":["CUSTOMER_ID"], 
       }

 

 If you want to construct the full content of message on your backend you can just place single params in the various content fields on the template:

Screen_Shot_2018-08-04_at_00.14.12.png

 

The same principle outlined above for SMS can be applied to email, the main difference with email is the potential to have more complex content in the body of the email such as a list of personalised product recommendations with images etc.. There are examples of the more dynamic content that can be added to emails using this approach in the following knowledge base articles:


 

 

Related articles

Comments

0 comments

Article is closed for comments.