Skip to main content

Custom events

Custom events let you track specific interactions on your retailer site. For example, you can use events to measure when a customer checks out their cart, cancels an existing order, or starts a shopping session. You can also integrate custom events into Shopping Widgets to enhance the user's experience. To integrate custom events to your retailer site, contact your Instacart representative.

Custom events are JavaScript-based and can be registered where they are needed. Some custom events will be initiated by widgets while others such as ic-session-ready, will be fired on the document object in your retailer site.

Document-initiated custom events

The following table describes the custom events that are fired on the document:

EventDescription
ic-session-readyIndicates that the Instacart Developer Platform API session has been set up and is ready to be called by the user.