Custom Block Interacted

📘
Note
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 Interacted event fires when a user interacts with a custom block based on the custom block action. Actions include adding a product to their cart, viewing a product, and viewing a collection.

The event properties unique to this event include:

  "event_properties": {
    "event_id": "a4abc3eb-10b7-4aba-811c-7aea349528cb",
    "custom_block_id": "1CQRv333fZ",
    "custom_block_index": "2",
    "custom_block_source_url": "https://custom-blocks.tapcart.com/fdJQt0eeepj/abde8s1443MQYHsewk/index.html",
    "custom_block_interaction_type": "collection_viewed",
    "custom_block_location": "home",
    "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

custom_block_interaction_type String : The type of interaction that occurred within the block

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

📘Note

📘
Note