Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.omni.co/llms.txt

Use this file to discover all available pages before exploring further.

You can send events into an Omni iframe to trigger actions in your embedded Omni application. Like emitted events, events sent to Omni should use the postMessage protocol.

​
Event shape

Events sent to Omni are expected to have the following shape: 
type EmbedEvent<Payload> = {
  payload: Payload
  name: EmbedEventName
}
The following is an example of a JavaScript event handler that sends a navigate embed event to an Omni iframe via postmessage: 
const handleNavigateButtonClick = (path) => {
  document.querySelector('iframe').contentWindow.postMessage(
    {
      name: "navigate",
      payload: { path },
    },
    "https://youromniorganization.embed-omniapp.co"
  );
};

​
Supported events

The following events can be sent to an Omni iframe:
EventDescription
appearance:modeTriggers a color scheme change of the embedded Omni session.
dashboard:filter-change-by-url-parameterTriggers the change of a filter value on an embedded dashboard.
navigateTriggers a redirect to the path specified in the payload.