GuidesAPI ReferenceChangelogDiscussions
Log In



All events include Session Properties, Device Properties, App Properties, and Shopify Properties that are present on the Event Object. For more information, refer to the Common Event Object & Metadata document.

Event Properties, however, are unique to every event and are outlined in this page.

The Custom Block Viewed event fires each time a custom block comes into view of the user's screen.

The event properties unique to this event include:

"event_properties": {
    "event_id": "a6087324-19ee-4f6f-bd6a-54044bc83788",
    "custom_block_id": "1CQRv333fZ",
    "custom_block_source_url": "",
    "custom_block_index": "3",
    "custom_block_location": "pdp",
    "static_position": null

event_id String : The unique identifier of the session associated with the event. This event will also exist on the Event object level as well

custom_block_id String : The unique ID of the custom code block

custom_block_source_url String : The unique source url of the custom block that represents the individual block

custom_block_index Integer : The index of the custom code block relative to all other blocks on that same page. Conditional blocks will be excluded from the index

custom_block_location String : The location of the custom block within the app

static_position String : The custom block's location on a static screen (ex: the cart is a static screen)

Note: To view all the various static positions, reference the Event Sources page