Skip to main content

ShopPass Webhook Events — Full Payload Reference

Full JSON payload reference for all ShopPass webhook events — store_page_view, collection_page_viewed, product_page_viewed, added_to_cart_ui, checkout_clicked, checkout_abandoned, and order_completed.

Written by Swapnil Sangal

ShopPass fires the following events in real time to your connected CRM or messaging platform. Use these to trigger personalised journeys — browse abandonment, cart recovery, post-purchase flows, and more.

Note: These payloads are structured specifically for ShopPass webhooks and are not intended as a reference for direct downstream integrations.

Events: store_page_view · collection_page_viewed · product_page_viewed · added_to_cart_ui · checkout_clicked · checkout_abandoned · order_completed


store_page_view

{
  "sessionId": "bec8b90f-xxxx-42dc-a0c3-8846eda60d62",
  "eventName": "store_page_view",
  "channel": "web",
  "timestamp": 1776854381425,
  "merchantId": "9813fc4e-xxxx-xxxx-xxxx-062c07129ee1",
  "eventPayload": {
    "abandoned_checkout_url": "",
    "clientData": {
      "clientIp": "45.248.16.43",
      "userAgent": "Mozilla/5.0 ...",
      "analytics": {
        "fb": { "fbp": "fb.1.xxx", "fbc": "fb.1.xxx" },
        "moEngage": { "moe_uuid": "" },
        "webengage": { "anonymousId": false, "userIdType": "anonymousId" },
        "ga": { "client_id": "1400910870.xxx", "user_id": "7a70af3b-xxxx" }
      },
      "brandUrl": "https://domain.myshopify.com"
    },
    "uiData": {
      "pageUrl": "https://domain.com/pages/order-status",
      "pageTitle": "Order Status – Merchant Name",
      "pagePath": "/pages/order-status",
      "utmParams": [],
      "landingPageUrl": "/pages/order-status",
      "referrerPageUrl": ""
    },
    "userData": {
      "networkSpeed": "fast",
      "userId": "3b855317-xxxx-xxxx-xxxx-478b3e84545e",
      "phone": "+91xxxxxxxxxx",
      "email": "mymail@ymail.com",
      "firstName": "",
      "lastName": ""
    }
  }
}

collection_page_viewed

{
  "event_name": "collection_page_viewed",
  "session_id": "fe2ddc06-xxxx-4a6a-8b84-2cbf05c68cb1",
  "phone": "+91xxxxxxxxxx",
  "timestamp": 1779876781484,
  "data": {
    "channel": "web",
    "email": "xxxx@gmail.com",
    "long_session_id": "94b40be7-xxxx-49c9-a6df-8b337151766b",
    "landing_page_url": "/collections/all",
    "referrer_page_url": "https://shopflo.myshopify.com/",
    "collection_page_url": "/collections/all",
    "page_url": "https://shopflo.myshopify.com/collections/all",
    "page_title": "Products – shopflo",
    "utm_data": [],
    "user_data": {
      "userId": "2c748278-xxxx-xxxx-xxxx-75a35cd9d696",
      "phone": "+91xxxxxxxxxx",
      "email": "xxxx@gmail.com",
      "firstName": "xxxx",
      "lastName": ""
    }
  }
}

product_page_viewed

{
  "event_name": "product_page_viewed",
  "session_id": "fe2ddc06-xxxx-xxxx-xxxx-2cbf05c68cb1",
  "phone": "+91xxxxxxxxxx",
  "timestamp": 1779876457771,
  "data": {
    "channel": "web",
    "email": "xxxx@gmail.com",
    "long_session_id": "94b40be7-xxxx-xxxx-xxxx-8b337151766b",
    "landing_page_url": "/products/the-collection-snowboard-liquid",
    "referrer_page_url": "https://shopflo.myshopify.com/",
    "utm_data": [],
    "product_image": "https://cdn.shopify.com/...",
    "product_url": "https://shopflo.myshopify.com/products/the-collection-snowboard-liquid",
    "product_name": "The Collection Snowboard: Liquid",
    "product_price": "749.95",
    "product_compare_at_price": "",
    "product_type": "snowboard",
    "user_data": {
      "userId": "2c748278-xxxx-xxxx-xxxx-75a35cd9d696",
      "phone": "+91xxxxxxxxxx",
      "email": "xxxx@gmail.com",
      "firstName": "xxxx",
      "lastName": ""
    }
  }
}

added_to_cart_ui

{
  "event_name": "added_to_cart_ui",
  "session_id": "fe2ddc06-xxxx-4a6a-8b84-2cbf05c68cb1",
  "checkout_id": "",
  "token_id": "",
  "source": "shopflo",
  "line_items": [
    {
      "title": "The Collection Snowboard: Liquid",
      "quantity": 2,
      "item_id": "55589142888521",
      "variant_id": "55589142888521",
      "product_id": "15510899228745",
      "price": 74995,
      "product_image": "https://cdn.shopify.com/...",
      "product_url": "https://shopflo.myshopify.com/products/...",
      "vendor": "Hydrogen Vendor"
    }
  ],
  "cart_variant_ids": "55589142888521",
  "cart_product_ids": "15510899228745",
  "cart_product_names": "The Collection Snowboard: Liquid",
  "currency": "INR",
  "total_price": 149990,
  "landing_page_url": "/",
  "long_session_id": "94b40be7-xxxx-xxxx-xxxx-8b337151766b",
  "user_data": {
    "userId": "2c748278-xxxx-xxxx-xxxx-75a35cd9d696",
    "phone": "+91xxxxxxxxxx",
    "email": "xxxx@gmail.com",
    "firstName": "xxxx",
    "lastName": ""
  },
  "timestamp": 1779876657975
}

checkout_clicked

{
  "event_name": "checkout_clicked",
  "session_id": "fe2ddc06-xxxx-4a6a-8b84-2cbf05c68cb1",
  "checkout_id": "604a57b3-xxxx-xxxx-xxxx-63ec2bcabe69",
  "token_id": "8fc24a27-xxxx-xxxx-xxxx-02473d275b6c",
  "source": "shopflo",
  "line_items": [
    {
      "item_id": "55589142888521",
      "price": 749.95,
      "product_id": "15510899228745",
      "quantity": 3,
      "title": "The Collection Snowboard: Liquid",
      "variant_id": "55589142888521"
    }
  ],
  "cart_variant_ids": "55589142888522",
  "cart_product_ids": "15510899228749",
  "cart_product_names": "The Collection Snowboard: Liquid",
  "currency": "INR",
  "total_price": 2249.85,
  "long_session_id": "94b40be7-xxxx-xxxx-xxxx-8b337151766b",
  "user_data": {
    "type": "na",
    "userId": "2c748278-xxxx-xxxx-xxxx-75a35cd9d696",
    "authSource": "SHOPFLO",
    "customerType": "NEW",
    "phone": "+91xxxxxxxxxx",
    "email": "xxxx@gmail.com",
    "firstName": "xxxx",
    "lastName": ""
  },
  "timestamp": 1779876709686
}

checkout_abandoned

{
  "event_name": "checkout_abandoned",
  "session_id": "6463d2bb-xxxx-419a-b72f-faed8ff3dd83",
  "checkout_id": "xxxx_xxxx_xxxx_xxxx",
  "token_id": "https://checkout.shopflo.co/?tokenId=xxxx",
  "source": "shopflo",
  "email": "xxxxxxx@shopflo.com",
  "phone": "+919000000000",
  "created_at": "2023-06-12T06:39:22.029830Z",
  "updated_at": "2023-06-12T06:45:07.859108Z",
  "note_attributes": [
    { "name": "landing_page", "value": "/products/all-day-cotton-pencil-pants" },
    { "name": "shopflo_checkout_url", "value": "https://checkout.shopflo.co/?tokenId=xxxx" }
  ],
  "line_items": [
    { "price": "799.00", "id": "43581879451904", "product_id": "8135050133760", "quantity": 1, "title": "XXXXX", "sku": "1836109039002" },
    { "price": "1599.00", "id": "43501980123392", "product_id": "8101659902208", "quantity": 1, "title": "YYYYYY", "sku": "1506104001002" }
  ],
  "customer": {
    "uid": "xxxx",
    "first_name": "XXXXXXX",
    "last_name": "XXXXXX",
    "phone": "+919123456789",
    "marketing_consent": true
  },
  "currency": "INR",
  "subtotal_price": 2398,
  "total_discount": 0,
  "total_shipping": 0,
  "total_price": 2398,
  "timestamp": 1779700813605
}

order_completed

{
  "event_name": "order_completed",
  "session_id": "fe2ddc06-xxxx-xxxx-xxxx-2cbf05c68cb1",
  "token_id": "8fc24a27-xxxx-xxxx-xxxx-02473d275b6c",
  "source": "shopflo",
  "email": "xxxx@gmail.com",
  "phone": "+91xxxxxxxxxx",
  "created_at": "2026-05-27T10:01:19.419291Z",
  "updated_at": "2026-05-27T10:16:09.696807Z",
  "line_items": [
    {
      "price": "749.95",
      "id": "55589142888521",
      "product_id": "15510899228745",
      "quantity": 3,
      "title": "The Collection Snowboard: Liquid",
      "variant_name": "Default Title",
      "sku": ""
    }
  ],
  "customer": {
    "uid": "2c748278-xxxx-xxxx-xxxx-75a35cd9d696",
    "email": "xxxx@gmail.com",
    "first_name": "xxxx",
    "last_name": "xxxx",
    "phone": "+91xxxxxxxxxx",
    "marketing_consent": true
  },
  "currency": "INR",
  "subtotal_price": 2249.85,
  "total_discount": 0,
  "total_shipping": 379,
  "total_tax": 404.97,
  "total_price": 2628.85,
  "total_payable": 2628.85,
  "discount_codes": [],
  "payment_mode": "COD",
  "order_id": 12121212121212,
  "order_name": "#1002",
  "timestamp": 1779876969665
}


Need help setting up a flow? Reach out to support@shopflo.com.

Did this answer your question?