Last modified October 5, 2018

This article applies to Contextual Commerce. (Looking for Classic Commerce documentation?)

The mailingListEntry.updated server webhook event is fired upon adding a new mailing list entry, e.g. for a customer who completed an order and selected the check box to "subscribe to news and updates".  Please see Cart Abandonment Tracking and Customer Mailing List Opt-In for more information.

About Webhook Expansion

mailingListEntry.updated is not affected by webhook expansion.

Contents of Event Payload

Name Type Description
id string ID of the event
list string list for which the email address entry has been updated: subscribed, unsubscribed or abandoned
updated integer date of the update, in milliseconds
reason string reason the list was updated: failed, subscribed, unsubscribed or abandoned
order object details of the transaction associated with the update, if any
order.reference string if the order was not completed at the time of the update, this will be null; otherwise, it is the customer-visible order reference for the transaction string internal ID of the order, if applicable
order.order string internal ID of the order, if applicable
order.items array list of products that were in the cart at the moment the email address was entered; one object per product; this data can be useful in creating customized re-marketing email messages; see Products for more information on object contents
order.items.product string product path / product ID
order.items.quantity integer quantity of the current product that was selected
order.items.display string customer-facing Display name of the product
order.items.summary string descriptive text from the product's Summary field
order.items.imageURL string URL of the product's Icon image file, hosted by FastSpring
email string email address that was updated
firstName string first name associated with the customer's email address, if known
lastName string last name associated with the customer's email address, if known


mailingListEntry.updated webhook example
        "display":"Furious Falcon",
        "summary":"Lorem ipsum dolor sit amet, consectetuer adipiscing elit.",