Embed Events

The embed SDK emits events that your application can listen to, enabling deep integration between Orderly embeds and your UI.

Listening to Events


Orderly.on('bridge:connected', (event) => {
  console.log('Bridge connected:', event.bridgeId);
  // Update your UI, show a success message, etc.
});
 
Orderly.on('order:selected', (event) => {
  console.log('User selected order:', event.orderId);
});

Available Events

Event	Description
`bridge:connected`	End user connected a new bridge
`bridge:disconnected`	End user removed a bridge
`order:selected`	End user clicked on an order
`shipment:selected`	End user clicked on a shipment
`session:expired`	The embed session has expired
`error`	An error occurred in the embed

Removing Listeners


const handler = (event) => console.log(event);
Orderly.on('bridge:connected', handler);
 
// Later
Orderly.off('bridge:connected', handler);