Back to Cal

Embed Events

docs/developing/guides/embeds/embed-events.mdx

6.2.03.2 KB
Original Source
<Info> For comprehensive documentation on embed events including usage examples and all available events, please refer to the [Cal.com Help Center - Embed Events](https://cal.com/help/embedding/embed-events). </Info>

Internal Events

These events are used internally by the embed system for communication between the iframe and parent window. They are prefixed with __ and are not intended for external use.

ActionDescriptionProperties
__iframeReadyFired when the embedded iframe is ready to communicate with parent snippet.isPrerendering: boolean // Whether the iframe is in prerender mode
__windowLoadCompleteTells that window load for iframe is complete.None
__dimensionChangedTells that dimensions of the content inside the iframe changed.iframeWidth: number
iframeHeight: number
isFirstTime: boolean // Whether this is the first dimension change
__routeChangedFired when the route changes within the iframe.None
__closeIframeFired when the iframe should be closed.None
__connectInitiatedFired when connection to a prerendered iframe is initiated.None
__connectCompletedFired when connection to a prerendered iframe is completed.None
__scrollByDistanceInstructs the parent to scroll by a specific distance.distance: number // Distance in pixels to scroll by

<Info>Events that start with __ are internal and should not be relied upon for external integrations as they may change without notice.</Info>

To get more details on how Embed actually works, you can refer to this Embed Flowchart.