Sending embed events to Omni

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:

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.
`navigate`	Triggers a redirect to the path specified in the payload.

Embed events

Consuming embed events sent by Omni

⌘I

Getting started

Setup

App customization

Events & interactivity

Admin

Sending embed events to Omni

Event shape

Supported events

​Event shape

​Supported events

Event shape

Supported events