Abandoned Checkout Recovery

The Abandoned Checkout Recovery Webhook is triggered whenever a checkout session is created or updated. It facilitates real-time synchronization of checkout data with external systems, enabling accurate tracking of active shopping sessions. This webhook plays a vital role in identifying potential checkout abandonment scenarios and allows businesses to automate recovery actions such as follow-up emails, whatsapp messages, personalized notifications, or remarketing efforts. By leveraging this integration, brands can engage customers at the right moment and significantly improve checkout conversion rates.

Headers

string

A secret key used to verify that the webhook request originated from FlexyPe. Ensure this token is validated to prevent unauthorized access.

string

The version of the webhook payload. Here, the value will be 2025-09.

string

The unique identifier for the event that triggered this webhook.

Body

string

The Shopify domain of the store (e.g., store.myshopify.com).

string

URL to redirect the user to FlexyPe Checkout.

number

default:"0"

The total discount applied to the entire cart, in the store’s currency.

number

The final amount the user has to pay after discounts and calculations.

string

The current status of the checkout session. This field reflects which step the user is on during their cart journey.Possible values:

INITIATED: Cart session has been created but no user input has been provided.
PHONE_ENTERED: User has entered a phone number.
OTP_VERIFIED: User has successfully verified the OTP.
ADDRESS_LOADED: Address screen has been rendered or prefilled.
ADDRESS_SHIPPING_SELECTED: Shipping method has been selected after address submission.
PAYMENT_LOADED: Payment screen has been rendered.
PAYMENT_INITIATED: Payment has been initiated by the user.
COMPLETED: Order has been successfully completed.

array

List of products currently added to the user’s cart at the time of checkout.

Show Item Properties

string

URL of the product image displayed to the user during checkout.

string

Title describing the selected product variant.

number

default:"0"

The discount amount applied to the item, in the store’s currency.

number

The price per unit of the item after applying any discounts.

number

The number of units of the product added to the cart.

object

Detailed information about the specific product variant selected.

Show Variant Properties

string

Descriptive label of the selected variant.

number

Price of the specific variant of the product.

number

Unique identifier assigned to this variant in Shopify.

number

The original price before discounts — shown as strikethrough on the UI.

number

Unique identifier for the base product in Shopify.

number

ID of the variant selected, same as variant.variant_id (duplicated for convenience).

number

default:"0"

Weight of the product variant in grams. Useful for shipping calculations.

string

The URL-friendly handle of the product, used in Shopify product URLs.

number

Total payable price for this item, calculated as price × quantity.

number

Total price for the item before any discounts are applied.

number

Cumulative discount applied to the item (if any).

boolean

default:"false"

Indicates whether the product has only one variant available (true/false).

User Object

Show properties

string

The customer’s phone number used during checkout.

string

The country code associated with the user’s phone number.

string

The customer’s name used during checkout.

string

The customer’s email used during checkout.

object

An object representing the user’s address based on session_state

Show Address Properties

string

Primary address line, typically containing street name, building number, or apartment name.

string

(Optional) Secondary address line, such as apartment number, suite, or additional details.

string

The city or locality of the user’s shipping or billing address.

string

Full name of the state or province associated with the address.

string

Full name of the country (e.g: “India”).

string

ISO 3166-2 code for the state (e.g: “GJ” for Gujarat).

string

ISO 3166-1 alpha-2 code for the country (e.g: “IN” for India).

string

Postal or ZIP code corresponding to the address.

string

The Shopify domain/subdomain for the merchant store.

ClientMeta Object

Metadata about the client’s device and request.

Show properties

string

IP address of the client at the time of checkout initiation.

string

Referring URL from which the user was directed to the store.

string

User agent string from the user’s browser or device.

Analytics Object

Data related to marketing and tracking attribution.

Show properties

string

Facebook Click ID (FBC) used for ad tracking. May be empty if unavailable.

string

Facebook browser ID (FBP) for retargeting and attribution.

Metadata Object

Metadata captured from the user’s landing page and original source. This is typically used for attribution, analytics, and campaign performance tracking.

Show properties

array

An array of key–value pairs representing UTM and tracking parameters passed in the landing page URL.Allowed keys:

fbclid: Facebook Click ID
gclid: Google Ads Click Identifier
utm_medium: Type of marketing channel
utm_source: Origin platform
utm_campaign: Campaign name or identifier
utm_content: Specific content or creative used
utm_term: Paid search keyword or targeting term

Show UTM Parameter Properties

string

One of the allowed analytics parameter keys listed above.

string

The value associated with the given analytics parameter.

string

The original referrer URL from which the user landed on the store.

string

The host domain extracted from the original referrer URL.

string

The specific page path on the store where the user first landed.

{
  "webhook_id": "wh_123",
  "shopify_domain": "my-store.myshopify.com",
  "cart_items": [],
  "checkout_url": "https://checkout.flexype.io/...",
  "discount": 0,
  "total_payable": 999,
  "session_state": "INITIATED",
  "user": {
    "phone_no": "9876543210",
    "dial_code": "91",
    "name": "John Doe",
    "email": "[email protected]",
    "address": {}
  },
  "store_link": "https://my-store.com",
  "coupons": [],
  "client_meta": {
    "client_ip": "1.1.1.1",
    "http_referer": "",
    "user_agent": "",
    "browser_fingerprint": ""
  },
  "analytics": {},
  "metadata": {}
}

Get Started

Features

Platforms

Integrations

Webhooks

Miscellaneous

Abandoned Checkout Recovery

Headers

Body

​Headers

​Body

Headers

Body