Overview

This document describes how to listen for payout-related tracking events emitted by the Breeze payout iframe via the browser's postMessage API. These events allow the host (parent) page to monitor user interactions within the embedded Breeze hosted payout form — without directly accessing the iframe's DOM. This is useful for analytics, conversion funnel tracking, and triggering custom UI behavior in response to payout flow activity.

Usage

Register a message event listener on the window object. Incoming messages with type === "on-payout-event" originate from the Breeze iframe. The specific event name is available at event.data.data.eventName.

// Register event listener for iframe messages
const handleIFrameRequest = (event: MessageEvent) => {
  if (event.data?.type === "on-payout-event") {
    // Handle the callback here
    handleEvent(event.data.data?.eventName);
  }
};

window.addEventListener("message", handleIFrameRequest);

Event Reference