Send a triggered email using WSProxy

Triggered sends allow you to automatically send personalized and timely messages to your subscribers. They are sent to an individual subscriber in response to a subscriber action. If you would like to find out more about creating a Triggered Email Message Interaction, check out my other article here.

TriggeredSend object

The TriggeredSend object represents a specific instance of a triggered email send. A typical SOAP envelope consists of the Triggered Send CustomerKey (External Key of the Triggered Email Message Interaction), Subscribers associated with the send and optionally, their Attributes. Here’s an example:

	<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
	<Header>
	<fueloauth>YOUR_ACCESS_TOKEN</fueloauth>
	</Header>
	<Body>
	<CreateRequest xmlns="http://exacttarget.com/wsdl/partnerAPI">
	<Objects xsi:type="TriggeredSend">
	<PartnerKey xsi:nil="true"/>
	<ObjectID xsi:nil="true"/>
	<TriggeredSendDefinition>
	<PartnerKey xsi:nil="true"/>
	<ObjectID xsi:nil="true"/>
	<CustomerKey>Definition_Key</CustomerKey>
	</TriggeredSendDefinition>
	<Subscribers>
	<PartnerKey xsi:nil="true"/>
	<ObjectID xsi:nil="true"/>
	<EmailAddress>email@test.com</EmailAddress>
	<SubscriberKey>email@test.com</SubscriberKey>
	<Attributes>
	<Name>firstname</Name>
	<Value>John</Value>
	</Attributes>
	</Subscribers>
	</Objects>
	</CreateRequest>
	</Body>
	</Envelope>

view raw triggered-send-soap-envelope.xml hosted with ❤ by GitHub

Create a TriggeredSend using WSProxy

WSProxy is a new object for Server-Side JavaScript, introduced by Salesforce in 2018. It acts as a proxy between the Marketing Cloud SOAP Web Service and SSJS. The WSProxy object is native to the platform and simpler to use than the SSJS methods, that’s why it reduces overhead and increases the speed of API calls. WSProxy uses JSON to pass object properties instead of SOAP’s native XML, which makes it much easier to read and write.

To create a new TriggeredSend, we will use the createItem WSProxy function, which has three parameters:

The first parameter is the object type to perform the action on – here, we will use previously mentioned TriggeredSend object
The second parameter is a JavaScript object which represents the fields and values to set on the object when created – in below example, we will call it tsDef and use it to define the CustomerKey, Subscribers and optionally, their Attributes
The third parameter is optional and includes any properties to be set using the SOAP CreateOptions object

Here’s the full script:

      
        <script runat="server">
      
        Platform.Load("Core", "1")    
      
        var prox = new Script.Util.WSProxy();
      
        var tsExKey = 'External Key'; //pass Triggered Send External Key
      
        var EmailAddress = 'example@example.com'; //pass Email Address
      
        var SubscriberKey = 'example@example.com'; //pass Subscriber Key
      
        var tsDef = {
      
            TriggeredSendDefinition: {
      
                CustomerKey: tsExKey
      
            },
      
            Subscribers: [{
      
                EmailAddress: EmailAddress,
      
                SubscriberKey: SubscriberKey
      
            }]
      
        };
      
        var res = prox.createItem('TriggeredSend', tsDef);  
      
        Write(Stringify(res));
      
        </script>

view raw triggered-send-wsproxy.js hosted with ❤ by GitHub

In the above script, you will need to provide the Triggered Send External Key and pass an Email Address and Subscriber Key.

If you are using personalization strings in your Triggered Email, you can pass them as name and value pairs in the Attributes object. Here’s an example of passing additional attributes in the WSProxy call:

      
        <script runat="server">       
      
        var prox = new Script.Util.WSProxy();
      
        var tsExKey = ''; //provide Triggered Send External Key
      
        var EmailAddress = ''; //pass Email Address
      
        var SubscriberKey = ''; //pass Subscriber Key
      
        var firstName = ''; //pass First Name
      
        var lastName = ''; //pass Last Name
      
        var tsDef = {
      
            TriggeredSendDefinition: {
      
                CustomerKey: tsExKey
      
            },
      
            Subscribers: [{
      
                EmailAddress: EmailAddress,
      
                SubscriberKey: SubscriberKey,
      
                Attributes: [{
      
                    Name: 'firstName',
      
                    Value: firstName
      
                }]
      
            }]
      
        };
      
        var res = prox.createItem('TriggeredSend', tsDef);      
      
        </script>

view raw personalized-triggered-send-wsproxy.js hosted with ❤ by GitHub

The results of the call contain three properties from the SOAP CreateResult object: Status, RequestID, and Results. Here’s an example response:

      
        { 
      
           "Status":"OK",
      
           "RequestID":"abcd1234",
      
           "Results":[ 
      
              { 
      
                 "SubscriberFailures":[ 
      
                 ],
      
                 "NewID":0,
      
                 "NewObjectID":null,
      
                 "PartnerKey":null,
      
                 "Object":null,
      
                 "CreateResults":null,
      
                 "ParentPropertyName":null,
      
                 "StatusCode":"OK",
      
                 "StatusMessage":"Created TriggeredSend",
      
                 "OrdinalID":0,
      
                 "ErrorCode":0,
      
                 "RequestID":null,
      
                 "ConversationID":null,
      
                 "OverallStatusCode":null,
      
                 "RequestType":"Synchronous",
      
                 "ResultType":null,
      
                 "ResultDetailXML":null
      
              }
      
           ]
      
        }

view raw wsprosy-ts-response.json hosted with ❤ by GitHub

To see how this script works in action, visit the CloudPage that I created and submit your email address here.

Here are additional resources to learn more about Triggered Sends and WSProxy:

Official documentation on Triggered Emails
Sending a Triggered Email using AMPscript
Introducing WSProxy by Eliot Harper

sfmarketing.cloud

Send a triggered email using WSProxy

TriggeredSend object

Create a TriggeredSend using WSProxy

Leave a Reply Cancel reply

	<script runat="server">
	Platform.Load("Core", "1")
	var prox = new Script.Util.WSProxy();
	var tsExKey = 'External Key'; //pass Triggered Send External Key
	var EmailAddress = 'example@example.com'; //pass Email Address
	var SubscriberKey = 'example@example.com'; //pass Subscriber Key
	var tsDef = {
	TriggeredSendDefinition: {
	CustomerKey: tsExKey
	},
	Subscribers: [{
	EmailAddress: EmailAddress,
	SubscriberKey: SubscriberKey
	}]
	};
	var res = prox.createItem('TriggeredSend', tsDef);
	Write(Stringify(res));
	</script>

	<script runat="server">
	var prox = new Script.Util.WSProxy();
	var tsExKey = ''; //provide Triggered Send External Key
	var EmailAddress = ''; //pass Email Address
	var SubscriberKey = ''; //pass Subscriber Key
	var firstName = ''; //pass First Name
	var lastName = ''; //pass Last Name
	var tsDef = {
	TriggeredSendDefinition: {
	CustomerKey: tsExKey
	},
	Subscribers: [{
	EmailAddress: EmailAddress,
	SubscriberKey: SubscriberKey,
	Attributes: [{
	Name: 'firstName',
	Value: firstName
	}]
	}]
	};
	var res = prox.createItem('TriggeredSend', tsDef);
	</script>

	{
	"Status":"OK",
	"RequestID":"abcd1234",
	"Results":[
	{
	"SubscriberFailures":[

	],
	"NewID":0,
	"NewObjectID":null,
	"PartnerKey":null,
	"Object":null,
	"CreateResults":null,
	"ParentPropertyName":null,
	"StatusCode":"OK",
	"StatusMessage":"Created TriggeredSend",
	"OrdinalID":0,
	"ErrorCode":0,
	"RequestID":null,
	"ConversationID":null,
	"OverallStatusCode":null,
	"RequestType":"Synchronous",
	"ResultType":null,
	"ResultDetailXML":null
	}
	]
	}

TriggeredSend object

Create a TriggeredSend using WSProxy

Share this:

Like this:

Leave a Reply Cancel reply