Transact XML API provides a mechanism for generating high volume, personalized messages.
Campaign Automation Transact assembles the email body, personalization, and content,
by using a highly customizable transaction email template that you create. Campaign Automation then sends the email to your contacts. Transact provides detailed tracking, a high level of deliverability, and round-trip reporting.
Examples of transactional messages are:
- Order Confirmations
- Ship Confirmations
- Password Reset information
- Alert Messages
- Customer Service Messages
Transact and Campaign Automation work together to provide you with a solution that
makes your Automated Messages powerful and effective, yet easy to run. With Campaign Automation
Transact you can:
- Generate rich HTML messages for receipts, notifications, and alerts from any message source across your organization.
- Ensure that each message includes appropriate branding elements.
- Include important and relevant cross-sell and up-sell messaging.
- Track opens, clicks, and other contact actions.
- Improve deliverability rates.
- Ensure CAN-SPAM compliance.
How it works
- An action causes email messages to originate on your system.
- Your system communicates with Campaign Automation through the transfer of XML or SMTP data.
- Campaign Automation receives the data and responds with the appropriate status codes.
- Messages are mapped to the appropriate templates.
- Emails are populated and sent out in real-time.
- Data is written into the database for reporting purposes.
- Contact actions are tracked and are viewable in reporting.
- If messages cannot be delivered to a contact immediately, Transact retries
every 15 minutes for 24 hours
- Messages that cannot get delivered within 24 hours are returned to Campaign Automation as undeliverable, on a per contact basis
- Duplicate Sending allows one or more individuals (or an assigned mailbox) to receive a single copy of ALL mailings that are sent from Transact.
How is the data submitted?
Campaign Automation uses an XML API to submit transaction activities and email responses. The API is intended for integration with backend systems. Users can submit mailing requests to Transact through XML (Extensible Markup Language) by using these submission methods:
- IP address
- HTTP Submission: Data is passed to the Transact server via the HTTP(S). This is limited to 10 contacts.
- FTP Submission: Data is passed to the transact server via XML over (S) FTP. This can include 10 – 5000 contacts.
- OAuth Authentication: Users without a dedicated IP address can make calls to the Campaign Automation API by using an OAuth access token to authenticate.
Transact does not check how many individual recipients are included in each batch file but, it does check the size of an individual batch file, of which we have two separate limits.
Roles and Responsibilities
The following roles and responsibilities of your organization and Campaign Automation are required to successfully send your customer mailings:
Campaign Automation Support
Campaign Automation Support (also referred to System Administrator) is your go-to team for
the Campaign Automation and Transact applications. Campaign Automation Support must create a Transact Organization for you and enable it for Transact sends.
Your company assigns an Organization Administrator to manage all Campaign Automation content.
The Organization Administrator is responsible for Campaign Automation settings and ensuring your
organization’s system (backend) integration is complete. Organization Administrators can help identify content, tags, and dynamic link URLs needed for each mailing.
Each organization can have multiple users. A user is responsible for creating shared databases, Automated Messages, and mailing templates, as well as automating mailings, assigning mailings to an Automated Message, and testing the mailings in Campaign Automation and Transact. Users can help identify content, tags, and dynamic link URLs needed for each mailing.
The organization developer ensures that your organization’s backend systems are configured to work with the Campaign Automation and Transact applications. The developer must also make sure that the system successfully sends and receives data. They must also have a working knowledge of the Campaign Automation Mailing Template fields and Transact XML required fields so coding is successful.
Content and Legal information
This document contains proprietary information, code, and programming data that is protected by copyright. All rights are reserved. No part of this document can be photocopied, reproduced, or translated to another language without prior written consent of Campaign Automation.
This document describes an XML application programming interface (API) for running certain functions of Campaign Automation Transact. The purpose of this document is to assist marketing professionals, developers, and other IT professionals to use Campaign Automation Transact to send transaction response emails and to automate the interactions between their current computer and software systems and Campaign Automation Transact. If used incorrectly, critical data can be altered or deleted. Users who create and send XML Submit documents should have knowledge of internet technologies that include:
- Experience with XML
- FTP file transfers (if using FTP)
Other users of this document should have knowledge of the above technologies, in addition to the following:
- Basic knowledge of XML Namespaces and XML schema
- Server-side programming language (PHP, JAVA/JSP, ASP, Perl, and so on.)
- TCP/IP Protocol
- Hypertext Transport Protocol
- Socket programming
If you need support related to the use of these XML APIs, contact Client Support to open a support ticket.
The schemas in this document for Campaign Automation Transact are provided in the documentation for illustrative purposes only. Copying schemas and using them for XML validation in a production environment is not recommended without thorough testing.
Generally, usage of the Campaign Automation XML API is governed by the same terms and conditions as set forth in your Campaign Automation Transact License Agreement or Campaign Automation Services Agreement (an Agreement). Usage of the Campaign Automation XML API is strictly prohibited unless you have a valid, unexpired Agreement in place.
Specifically, Campaign Automation hereby grants you a limited, nonexclusive, nontransferable, nonsublicensable, worldwide right to use the XML API in support of your development efforts only. All rights that are not expressly granted to you are reserved by Campaign Automation. You shall not (i) license, sublicense, sell, resell, transfer, assign, distribute, or otherwise commercially exploit or make available to any third party the XML API or Transact in any way; or (ii) reverse engineer or access the XML API or Transact in order to (a) build a competitive product or service, (b) build a product using similar ideas, features, functions or graphics, or (c) copy any ideas, features, functions, or graphics, except with Campaign Automation‘s prior written approval in each instance. Licenses cannot be shared or used by more than one individual.