Storefront

Storefront events fire when a shopper interacts with the cart or checkout. Storefront events trigger sync automations. This means they run on a user’s critical path and must be fast and deterministic. Because of this, they have some contraints:

they can’t use any of the Agent steps
they can’t use delay, wait_for_event, parallel, map steps
they have execution timeout of 10 seconds
only one automation can be active for each event

Shopper PII in storefront event payloads is privacy-safe. Fields like customer_email can be null, and address details may be omitted when they are not needed for the event.

Cart

CART_CREATED

New shopping cart initialized.

object

Show properties

string

Unique cart identifier

CART_ITEM_ADDED

Item added to a cart.

object

Show properties

string

Unique cart identifier

CartItemData

Added item details

integer

Total items in cart

number

Cart subtotal

CART_ITEM_UPDATED

Cart item quantity changed.

object

Show properties

string

Unique cart identifier

CartItemData

Updated item details

integer

Previous quantity

integer

Total items in cart

number

Cart subtotal

CART_ITEM_REMOVED

Item removed from a cart.

object

Show properties

string

Unique cart identifier

CartItemData

Removed item details

integer

Total items in cart

number

Cart subtotal

Checkout

CHECKOUT_STARTED

Checkout session initiated.

object

Show properties

string

Unique checkout session identifier

string?

Cart identifier (if from cart)

string?

Order identifier

number

Checkout total

integer

Number of items

string?

Customer email

CHECKOUT_ADDRESS_SET

Billing address provided during checkout.

object

Show properties

string

Unique checkout session identifier

string?

Order identifier

number

Checkout total

string?

Customer email

Address?

Billing address, when available

CHECKOUT_PAYMENT_SELECTED

Payment provider selected during checkout.

object

Show properties

string

Unique checkout session identifier

string?

Order identifier

number

Checkout total

string?

Customer email

string

Selected payment provider

string?

Previously selected provider

CHECKOUT_COMPLETED

Checkout completed successfully.

object

Show properties

string

Unique checkout session identifier

string?

Order identifier

number

Checkout total

string?

Customer email

string?

Payment provider used

CHECKOUT_PAYMENT_FAILED

Payment failed during checkout.

object

Show properties

string

Unique checkout session identifier

string?

Order identifier

number

Checkout total

string?

Customer email

string?

Payment provider used

string?

Error code

string?

Error message

CHECKOUT_VALIDATE_DISCOUNT_CODE

Customer submitted a discount code at checkout. Synchronous return event — automation must produce a DiscountValidationResult.

object

Show properties

string

Unique checkout session identifier

string?

Order identifier

string

The code the customer entered

number

Order subtotal in dollars (used to compute percentage discounts)

string

Currency code

string?

Customer email (for per-customer limits)

Required automation output:

object

Show properties

boolean

Whether the code is accepted

string

Echo of the submitted code

"fixed_amount" | "percentage"

How the discount is calculated

integer?

Discount in cents (required when discount_type=fixed_amount)

integer?

Whole-number percent off (required when discount_type=percentage, 0-100)

string?

Human-readable label shown at checkout

integer?

Cap on total redemptions (null = unlimited)

Shared Types

object

Show properties

string

Product identifier

string

Product name

integer

Quantity in cart

number

Price per unit

number

Total for this line

object

Show properties

string

Street address

string?

Apartment, suite, etc.

string

City

string?

State or province

string

Postal/ZIP code

string

Country code

⌘I

Get started

Platform

Agents

Automations

Dev Tools

Storefront

Cart

Checkout

Shared Types

​Cart

​Checkout

​Shared Types

Cart

Checkout

Shared Types