Skip to main content
Omni emits this event one time for each page load, as soon as the embedded page can receive events from the parent frame. Wait for this event before you send events to Omni. Omni can’t receive an event that you send before page:ready. This event tells you that the page can receive events. It doesn’t tell you that the page has finished loading. Omni keeps the events that you send between page:ready and the end of the page load. When the page finishes loading, Omni handles these events in the order that you sent them.
Add your event listener before the iframe starts to load. If the listener is added later, your application can miss the page:ready event.

​
Behavior

  • Dashboard filters - Omni keeps a dashboard:filter-change-by-url-parameter event until the dashboard on the page is ready. Omni discards the event if the page isn’t a dashboard, or if the page changes before the dashboard is ready.
  • Fullscreen - Omni doesn’t keep fullscreen:set events that you send while the page loads.
  • Embed login page - Omni doesn’t emit page:ready from the embed login page. Omni emits the event from the content page that loads after login.

​
Payload

​
Properties

​
string
The fully qualified URL of the page that emitted the event, e.g., https://blobsrus.embed-omniapp.co/dashboards/123abc?f--users.state=California.
​
string
The path of the URL (e.g., /dashboards/123abc).

​
Example

​
Next steps