WorkflowCustomEvents collection allows triggering workflow custom events. Custom events are a ways to insert subscribers into workflows. Multiple custom events can be defined in any workflow. Subscribers can be added individually or as an entire segment, making it flexible and convenient for various needs.<\/p>\n\n\n\n
If a single custom event is used in multiple workflows, triggering it may cause inserting a subscriber or segment into multiple workflows.<\/p>\n\n\n\n
A business example could be a custom event called “Completing a sale”. We may want such event cause starting several workflows for a subscriber, e.g. workflow called “Post-purchase communication” or “Special offers for customers”.<\/p>\n\n\n\n
Data part of request for triggering workflow custom events<\/p>\n\n\n\n
Data element children:<\/p>\n\n\n\n *Either SubscriberId, SubscriberSegmentId, CustomSubscriberId, CustomChannelId, SubscriberEmail, SubscriberEmailMd5, SubscriberEmailSha256 or SubscriberPhone has to be specified to identify subscriber or segment. If more than one field is specified, precedence is established by the same order as in table above.<\/p>\n\n\n\n DataFields element children:<\/p>\n\n\n\n On success, this request will return HTTP code “201 Created”. No additional information is returned.<\/p>\n\n\n\n Request (simple request without data fields):<\/p>\n\n\n\nElement\/attribute<\/th> Type<\/th> Notes<\/th><\/tr><\/thead> CustomEventId<\/td> int<\/td> ID of custom event that will be triggered. Required.<\/td><\/tr> SubscriberId<\/td> int<\/td> ID of subscriber that triggers the event. Optional*.<\/td><\/tr> SubscriberSegmentId<\/td> int<\/td> ID of Segment that triggers the event. Optional*.<\/td><\/tr> CustomSubscriberId<\/td> string<\/td> Custom ID of subscriber that triggers the event. Optional*.<\/td><\/tr> CustomChannelId<\/td> string<\/td> Custom Channel ID of subscriber that triggers the event. Optional*.<\/td><\/tr> SubscriberEmail<\/td> string<\/td> Email of subscriber that triggers the event. Optional*.<\/td><\/tr> SubscriberEmailMd5<\/td> string<\/td> EmailMd5 of subscriber that triggers the event. Optional*.<\/td><\/tr> SubscriberEmailSha256<\/td> string<\/td> EmailSha256 of subscriber that triggers the event. Optional*.<\/td><\/tr> SubscriberPhone<\/td> string<\/td> Phone number of subscriber that triggers the event. Optional*.<\/td><\/tr> DataFields<\/td> complex<\/td> Collection of data fields related to the event (DataField elements). Optional.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n Element\/attribute<\/th> Type<\/th> Notes<\/th><\/tr><\/thead> Name<\/td> string<\/td> Name of data field. Required.<\/td><\/tr> Type<\/td> string<\/td> Type of data field. Required. Following field types are supported:
Text, e.g. foobar
Number, e.g. 123
Date, YYYY-MM-DD format, e.g. 2015-11-26
Datetime, YYYY-MM-DD hh:mm:ss format, e.g. 2015-11-26 12:00:00
Boolean, e.g. true, false, 1, 0<\/td><\/tr>Value<\/td> string<\/td> Data field value. Required.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n Response form<\/strong>at<\/strong><\/h3>\n\n\n\n
<\/a><\/a>Examples<\/strong><\/h3>\n\n\n\n