Skip to Content

Embed Configuration

Setting Up

  1. Go to Settings > Embed in the portal
  2. Enable the embed system
  3. Configure allowed origins (your application’s domains)
  4. Create a publishable key
  5. Define which features to expose

Configuration Options

SettingDescription
Allowed OriginsDomains that can initialize embeds
FeaturesWhich Orderly features to expose (bridges, orders, tracking)
BrandingCustom colors and logo for embedded components
PermissionsWhat end users can do within embeds

Via the API

PATCH /api/embed/config Content-Type: application/json { "enabled": true, "allowedOrigins": ["https://myapp.com", "https://app.mycompany.dev"], "features": { "bridges": true, "orders": true, "tracking": true, "shipments": false }, "branding": { "primaryColor": "#FF6B00", "logo": "https://myapp.com/logo.png" } }