analytics.beganCheckout¶
analytics.beganCheckout is an event on the Event Bus that occurs after a user has began a checkout process. This event only dispatches when analytics is enabled in the shop.
Event body¶
none
Example¶
In this example we listen to analytics.beganCheckout event and perform an action whenever it's emitted.
useStorefront(async (storefront) => {
storefront.eventBus.on('analytics.beganCheckout', () => {
console.log('A user has began a checkout process')
});
});
Example¶
In this example we use a Message Storage API to retrieve an array of past analytics.beganCheckout events.
useStorefront((storefront) => {
const messageStorageApi = storefront.getApiSync('messageStorageSystemApi');
const pastBeganCheckoutEvents = messageStorageApi.getChannelMessages('analytics.beganCheckout');
if (pastBeganCheckoutEvents.length > 0) {
pastBeganCheckoutEvents.forEach(({ body: eventBody }) => {
console.log('perform action on every past event');
});
}
});