Mailing List Entries

Use the mailingListEntry webhooks to collect abandoned cart information and send remarketing messages.

MailingListEntry webhooks collect email addresses and order information, which you can use for future marketing opportunities.

There are 3 mailingListEntry webhooks:

  • mailingListEntry.updated: Sends when a customer adds their email to your mailing list, or when the abandoned, subscribed, and unsubscribed lists change.
  • mailingListEntry.abandoned: Sends 30 minutes after the most recent activity. This applies if a customer entered their email, but did not complete their purchase.
  • mailingListEntry.removed Sends when someone removes an email address from the mailing list. This may happen when a customer unsubscribes.

Contents of Event Payloads

Name

Type

Description

id

string

ID of the event.

list

string

Updated list: subscribed, unsubscribed, or abandoned.

updated

integer

Date of the update, in milliseconds.

reason

string

Reason for the update: failed, subscribed, unsubscribed, or abandoned

order

object

Associated transaction information, if any.

    reference

string

Customer-facing order reference number. Null for incomplete transactions.

    id

string

Internal order ID.

    order

string

Internal order ID.

    referrer

string

URL of the page where the customer abandoned their cart.

    storefront

string

Storefront name.

    items

array

Products that were in the cart when the customer entered their email. This array contains one object per product.

        product

string

Product path / ID.

        path

string

Product path / ID of the parent product. This only applies to variations.

        quantity

integer

Product quantity.

        display

string

Product's display name.

        summary

string

Descriptive text from the product's summary field.

        imageURL

string

URL of the product's icon image file.

        isVirtual

boolean

True for all products.

        isSubscription

boolean

True if the product is a subscription

        variation

string

Product variation ID. This only applies to variations.

        description

string

Contents of the product's long description.

        sku

string

SKU ID of the product.

        pricing

object

Product price. May contain one string pairing for each currency.

abandoned_cart_session

string

Session ID of the abandoned cart. This expires after 24 hours.

abandoned_cart_session_url

string

Store ID with the abandoned cart/checkout session ID appended ie https://storename.onfastspring.com/session/abandoned_sessionID

abandoned_at

string

Date and time of the abandonment.

email

string

Email address entered or updated.

firstName

string

Customer's first name, if known.

lastName

string

Customer's last name, if known.

country

string

2 character ISO code of the country.

currency

string

3 character ISO code of the currency in the abandoned cart.

language

string

2 character ISO language code for the language in which FastSpring processed the transaction.

storefront

string

Storefront name.

referrer

string

Full URL of the page where the customer abandoned the cart.

optIn

string

True if the user has opted in to communications via the FastSpring checkout.

Examples

mailingListEntry.updated

{ 
  "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":"[email protected]",
  "firstName":"John",
  "lastName":"Doe"
}

mailingListEntry.abandoned

{
    "id": "11318408534c4eccacef0c585e9cf47739e56331ef3695ea4d0bbb3587788177",
    "list": "abandoned",
    "updated": 1619503632991,
    "reason": "abandoned",
    "order": {
        "reference": null,
        "id": null,
        "order": null,
        "referrer": "https://solisinc.test.onfastspring.com/",
        "session": "8YXf4EdPSfI:BknYgazoSSC-GjChXtHRMQ",
        "storefront": "solisinc",
        "items": [{
            "product": "dj-soft-pro",
            "path": "dj-soft-pro",
            "quantity": 1,
            "display": "Yosoy Pro Cloud",
            "summary": "Yosoy Pro Cloud subscription",
            "imageUrl": "https://d8y8nchqlnmka.cloudfront.net/8YXf4EdPSfI/fHonzeEtTVg/5af7b9528b57f731e597f866_66_Grooveshark.png",
            "isVirtual": false,
            "isSubscription": true,
            "price": 255.46,
            "variation": "dj-soft-pro",
            "description": "Music anytime anywhere",
            "sku": null,
            "pricing": {
                "values": {
                    "USD": 255.46
                }
            }
        }, {
            "product": "product-b",
            "path": "product-b",
            "quantity": 1,
            "display": "Product B",
            "summary": null,
            "imageUrl": null,
            "isVirtual": false,
            "isSubscription": false,
            "price": 41.19,
            "variation": "product-b",
            "description": "Product B",
            "sku": null,
            "pricing": {
                "values": {
                    "USD": 45.0,
                    "EUR": 41.19,
                    "GBP": 33.65
                }
            }
        }, {
            "product": "how-to-win-friends-ebook",
            "path": "how-to-win-friends-ebook",
            "quantity": 1,
            "display": "Summary of How to Win Friends and Influence Others",
            "summary": "fdfsdYXWin friends and influence others...",
            "imageUrl": "https://d8y8nchqlnmka.cloudfront.net/8YXf4EdPSfI/GG3I_ETRSWU/summary_of_winning_friends.jpg",
            "isVirtual": false,
            "isSubscription": false,
            "price": 6.99,
            "variation": "how-to-win-friends-ebook",
            "description": "You can go after the job you want—and get it!nnYou can take the job you have—and improve it!nnYou can take any situation—and make it work for you!nnDale Carnegie's rock-solid, time-tested advice has carried countless people up the ladder of success in their business and personal lives. One of the most groundbreaking and timeless bestsellers of all time, How to Win Friends & Influence People will teach you:nn-Six ways to make people like younn-Twelve ways to win people to your way of thinkingnn-Nine ways to change people without arousing resentmentnnAnd much more! Achieve your maximum potential—a must-read for the twenty-first century with more than 15 million copies sold!",
            "sku": "SKU-0001",
            "pricing": {
                "values": {
                    "EUR": 6.99,
                    "GBP": 3.56,
                    "USD": 5.99
                }
            }
        }]
    },
    "abandoned_cart_session": "BknYgazoSSC-GjChXtHRMQ",
    "abandoned_cart_session_url": "https://solisinc.test.onfastspring.com/session/BknYgazoSSC-GjChXtHRMQ",
    "abandoned_at": "2021-04-27 06:07:12",
    "email": "[email protected]",
    "firstName": "John",
    "lastName": "O",
    "country": "DE",
    "currency": "EUR",
    "language": "en",
    "storefront": "solisinc",
    "referrer": "https://solisinc.test.onfastspring.com/",
    "optIn": false
}

mailingListEntry.removed

{ 
  "id":"91143a785402b7867f965557e3eaf4e958cfac639c07c4d7b0726bfd6ed0bfbb",
  "list":"subscribed",
  "updated":1462371921845,
  "email":"[email protected]",
  "firstName":null,
  "lastName":null
}

Cart Abandonment Tracking

If a customer enters their email address without completing the transaction, FastSpring communicates their order information with a mailingListEntry.updated webhook.

Customer Experience:

  1. When a customer adds an item to their cart, a 30-minute timer starts. FastSpring considers the cart abandoned if the customer does not complete the order within 30 minutes.
  2. Within 15 minutes of marking the cart abandoned, FastSpring sends the mailingListEntry.updated webhook containing the customer's email address. The list and the reason are marked as abandoned.

The webhook collects the following information regarding the abandoned product. Information is collected seperately for each product in the cart:

  • Product: The product path or ID.
  • Quantity: The product quantity that the consumer selected.
  • Display: The product's display name.
  • Summary: The product's summary description.
  • ImageURL: The URL of the product's icon image file.

Customer Mailing List Opt-In

When checking out, customers can select a checkbox to opt in to future emails. FastSpring will follow the steps below to the status of each collected email.

  1. When a customer completes a purchase with a new email address, FastSpring sends their email in the mailingListEntry.updated webhook.
  2. If the customer opted in to future emails, FastSpring marks the list reason as subscribed. If they opted out, FastSpring marks them as unsubscribed.

If a customer opts in a multiple times with the same email address, FastSpring does not fire a webhook.

Customer Opt-Out

If a subscribed customer opts out, FastSpring sends 2 webhook events:

  • mailingListEntry.removed: Shows the list as subscribed. FastSpring will remove the email address from the mailing list.
  • mailingListEntry.updated: Shows the list and the reason as unsubscribed.

👍

For third-party remarketing services, see Extensions. These services assist you in receiving webhook data, parsing the information, and sending remarketing messages to consumers with abandoned carts.


Did this page help you?