Skip to main content

White-label embed portal

The embed lets your customers connect their own integrations, under your brand, inside your app. You issue a short-lived session for each end user, and they see a branded "Integrations" surface where they connect their own Shopify or other platforms. Manage it under Embed.

Activate the embed​

On the Embed page, choose a slug (like my-company) and click Activate. That gives you a publishable key and the embed URL.

Embed it in your app​

The setup card provides ready-to-copy snippets for React, JavaScript, Server, and iframe. The pattern is always the same: your server mints a session, and your frontend renders the embed with it.

  1. On your server, create a session for the signed-in customer:

    const orderly = new Orderly('oh_YOUR_API_KEY');
    const { clientSecret } = await orderly.embeds.createSession({
      externalId: 'cust_123',
      name: 'Acme Inc',
    });

  2. In your frontend, render the embed with that secret:

    import { OrderlyEmbed } from '@orderly/embed-react';

    <OrderlyEmbed fetchClientSecret={fetchClientSecret} />

Your publishable key (prefixed ek_) is safe to put in client-side HTML, and it is shown in the setup card. The simplest integration is a scoped iframe:

<iframe src="https://app.orderly-hub.com/embed/bridges?key=ek_...&user_id=cust_123&user_name=Acme+Inc"></iframe>
End users are created for you

You do not invite embed users by hand. An end user is provisioned automatically the first time your server calls createSession for their externalId. The Users page lists them and the bridges each has connected.

Brand it​

Under Embed → Branding, set your Primary, Background, and Text colors, Font Family, Border Radius, a Logo URL, and optional Custom CSS. A live preview renders your changes. Click Save Changes.

Configure what customers can do​

Under Embed → Settings:

  • Feature Modules toggles what the embed exposes: Bridges (always on), Live Data Room, Action Requests, Smart Alerts, End User Webhooks, and Branded Tracking.
  • Allowed Origins restricts which domains can load the embed.
  • Allowed Bridge Types limits which platforms customers can connect.
  • Default Dispatcher auto-routes orders from embed-created bridges.
  • Limits caps bridges per user.

Handle action requests​

If you enable Action Requests, your customers can submit requests against their orders (cancel, hold, expedite). They land in Embed → Action Requests as a review queue. Filter by status, then Approve or Deny each, with an optional resolution note.

The Events page is an audit log of embed activity: sessions created and revoked, bridges connected, and users removed.

Next steps​