Skip to content

Type Alias: EmbedProtocolMessage ​

ts
type EmbedProtocolMessage = 
  | HostToEmbedMessage
  | EmbedToHostMessage;

Any message in the Ridge iframe protocol: either a command from your app or a notification or reply from the iframe. The type field identifies the message and its payload.

Use isEmbedProtocolMessage(event.data) to check an incoming payload. Also check the event's origin and source; payload validation does not authenticate the sender.