mailingListEntry.updated
Overview
This article provides details about the mailingListEntry.updated webhook event.
The mailingListEntry.updated server webhook event fires upon adding a new mailing list entry, e.g., for a customer who completed an order and selected the newsletter checkbox. 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.IMPORTANT
Contents of Event Payload
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 would be null; otherwise, it is the customer-visible order reference for the transaction |
order.id | 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 |
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 |
Example
{ "id":"daf8f936dbf78731424aec6744068e07ef9ecd4d808dc9868c8d98c6ed4c63d0", "list":"subscribed", "updated":1462308750819, "reason":"subscribed", "order":{ "reference":"YES200316-9780-92149", "id":"hJl86j9FQBaPhlXhSjlbBw", "order":"hJl86j9FQBaPhlXhSjlbBw", "items":[ { "product":"example-product-1", "quantity":1 "display":"Example Product 1", "summary":"Lorem ipsum dolor sit amet, consectetuer adipiscing elit.", "imageUrl":"https://d8y8nchqlnmka.cloudfront.net/VTetZH1kQD8/-rl0Wko4SzQ/example-box.png" } ] }, "email":"jdoe@gmail.com", "firstName":"John", "lastName":"Doe" }