Sending embed events to Omni - Omni Docs

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"
  );
};

When to send events

Omni can’t receive an event that you send before the embedded page starts to listen. To make sure that Omni receives your events:

When the iframe loads a page, wait for the page:ready event before you send events
To apply filters each time a dashboard loads, send the filters in response to the dashboard:ready event

Supported events

The following events can be sent to an Omni iframe:

Event	Description
`appearance:mode`	Triggers a color scheme change of the embedded Omni session.
`dashboard:filter-change-by-url-parameter`	Triggers the change of a filter value on an embedded dashboard.
`fullscreen:set`	Sets the fullscreen presentation state of the embedded Omni session.
`navigate`	Triggers a redirect to the path specified in the payload.