Transactional Campaigns are Campaigns launched from outside of Accelerator using an API call. The Campaign settings (Templates, Personalization, etc) can be configured within Accelerator, but the contact attempt is called from outside of Accelerator. Common examples of Transactional Campaigns are triggered by password resets, purchase confirmations, and welcome emails.
Message must be enabled within Accelerator to configure Transactional Campaigns within Accelerator.
Table of Contents
Transactional Campaigns within Accelerator
Transactional Campaigns configured within Accelerator work similarly to Marketing Campaigns. Email, SMS, or Push Templates allow for a user to easily create the visual element of a Campaign.
There are benefits to creating the Transactional Campaigns within Accelerator. Creating the Campaign through the user interface encourages the use of Dynamic Content, personalization, and the use of the Template Drag-and-Drop Builder. Additionally, creating Transactional Campaigns through Accelerator allows for reporting and analytics on contacts made through the Campaign.
|It is possible to send Transactional Contacts without creating a Transactional Campaign within Accelerator. More information on this form of contacts later in this article.|
Transactional Campaigns do not use Audiences to process customer data in the same way that Marketing Campaigns do. The only reason an Audience is needed when setting up a Transactional Campaign is to ensure that the Template being used supports all needed channels.
If the Template of the Transactional Campaign utilizes multiple channels of communication, then an Audience with the necessary fields must be available.
When creating an Audience, the required fields for cross channel communication are clearly displayed. The required fields are the fields that display by default when creating an Audience.
|For more information on creating Audiences, refer to Creating and Editing Audiences.|
Templates must be configured for each contact channel that the Transactional Campaign requires. Transactional Campaigns require Templates.
Personalization can be used within Templates for Transactional Campaigns, but there is no Audience data that populates the personalization. When using the API call to trigger a Transactional Campaign to make a contact, the recipient data is included within the call. If using a personalization field called "firstName" within the Template, the API call must include a field of Recipient data called "firstName" exactly.
If the Template being used in the Campaign does not have an entry for a contact channel, then the Transactional Campaign will not support that type of contact.
After creating a Template that has entries for each type of contact, the Transactional Campaign can be created.
Create a Campaign
Navigate to Message → Delivery → Transactional to see any Transactional Campaigns that have already been created. Transactional Campaigns can be viewed in a file format or not. Switch the view using the two view buttons next to the Create Campaign button.
Click Create Campaign to create a new Transactional Campaign. The new Campaign is created immediately with a default name following this format: User Name Date Timestamp. Creating a Campaign will display the Campaign Overview screen.
This Campaign Overview screen, while sharing the same name, is different from the Campaign Overview screen displayed for Marketing Campaigns. Transactional Campaigns have fewer settings and requirements than Marketing Campaigns.
Update the name and descriptions of the Campaign by selecting the title.
While there are Campaign settings for the Transactional Campaigns, the first step of configuring a Transactional Campaign is to select a Template.
It is important that the Template have an entry for all channels that the Transactional Campaign will support.
Selecting a Template that supports more than one channel displays the appropriate channels within the Template selection. Different channels from the Template can be enabled or disabled for the Campaign by using the toggles.
The Notification Email Address is an email address that receives updates if there is an error with the Campaign.
The URL Append field can be used to add information to the URL for reasons like Link Tracking or Google Analytics.
Selecting a Template will change the Campaign Overview screen to display the Template and configurations selected.
Four new tabs display at the top of the Campaign Overview screen. View the Campaign Overview details by selecting the Overview tab.
The API Example tab contains a pre-generated example of an API call through the Transactional Campaign.
The API Example generated in this tab is based on the details of the Campaign.
|Copying and pasting the API Example and attempting an API call will not work right away. The API Example contains some variables like <bearerToken> and <promotedCampaignId> that are not yet accessible. The <promotedCampaignId> is generated after the Campaign is promoted. The <bearerToken> is a value that can be gathered through an API call.|
The API Example also contains Recipient Data. In an actual API call, this would contain the information of the recipient who will be contacted through the Campaign. The values in the API Example come from the Audience that is connected to the Template. Any fields established through the Template Audience, including Launch Variables, display within the API Example. Those fields showing in the API Example do not mean that all API calls must contain this information.
The required fields for a Transactional Campaign depend on the type of contact. It is also recommended that any values required for rendering the Template correctly be included in the API call.
The full API Example from the picture above:
Authorization: Bearer <bearerToken>
"context": "<?xml version="1.0" encoding="UTF-8" standalone="no"?><ContextData></ContextData>",
"<?xml version="1.0" encoding="UTF-8" standalone="no"?>
At the bottom of the API Example tab is the response that the API service sends back after a call.
This requestId can be used in another API call to view the contact sent to the recipient.
The <promotedCampaignId> within the API Example will be populated after the campaign has been promoted.
|Read more about using requestIds for reporting here.|
The Personalization tab displays the Template attached to the Transactional Campaign. Use this view to confirm that the Template is rendering correctly. Any personalized values within the Template need to be included in the API call in order to be utilized within the Template. Test the Template to confirm it renders successfully.
|For more information on testing Template Personalization, refer to End-to-End Newsletter Creating.|
The Spam Test tab runs the contact attempt that the Transactional Campaign will generate a test to determine the likeliness that a contact through this Campaign will be detected as Spam. Choose an Account and Sample Recipient and create the test.
The Spam test will return ratings through multiple services. Because of this, the test may take a few minutes to complete.
Promoting a Campaign
Similar to launching a Marketing Campaign, a Transactional Campaign must be promoted before use. Promoting a Campaign takes the settings of a Transactional Campaign and updates the API environment with the campaign details. Whether creating a new campaign or updating an existing campaign, the campaign must be promoted before it can be utilized through an API call.
Promoting a campaign will not cause contacts to immediately be sent. Instead, it will allow API calls to successfully access this Transactional Campaign and use the HTML and details of the campaign.
Click the Promote button at the top of the screen to promote the campaign. A prompt will appear.
Promoting a Campaign cannot be undone. Once it is sent to the Cloud environment, API calls can use the Campaign configuration to send contact attempts. To stop using a Campaign, simply stop calling it.
After promoting the Campaign, a new tab will display.
One benefit of using a Transactional Campaign is the easy reporting tool in the Analytics tab of the Campaign.
This tab is an easy method of viewing the results of contacts made through the Transactional Campaign. View the total deliveries, opens, clicks, attrition, bounces, and suppresses from contacts made through the Campaign.
Four logos display in the top right of the screen:
Use these buttons to break down the reporting information based on the type of contact. The first option includes totals of all forms of contact. The envelope logo only includes email contacts. The next logo is for Push contacts. The final logo is for SMS contacts.
Transactional Campaigns without Accelerator
It is possible to use API calls to launch Transactional Contacts without setup within Accelerator. Using the API method called Transactional Job Submit, a contact can be sent to a recipient without configuration of a Transactional Campaign. Personalization can still be used in this method.
If using this method, the HTML of the email contact will have to manually be configured within the API call. Because there is no Transactional Campaign, there is no attached Template to dictate what must be rendered. The HTML of an email contact must be included.
More information on the Transactional Job Submit can be found within the API Documentation.