Widget Settings
Widget
Section titled “Widget”The Widget tab configures a small order-status widget you can embed on your own website — typically the “Where’s my order?” block in the footer or a help page. Customers enter their order number and email, and the widget shows them the current status without sending them anywhere.
The widget is a hosted, branded embed: you pick a primary color, a title, and a description; the system gives you a copy-paste <script> snippet to drop on your site.
Open the tab from App Settings → Widget.
Table of contents
Section titled “Table of contents”- What this tab is for
- Enable / Disable
- Customization
- Embed code
- Preview
- The widget key
- Difference between Widget and Client Portal
- Tips and best practices
What this tab is for
Section titled “What this tab is for”Use this tab to:
- Add a self-service status block to your website without writing code.
- Brand it with your primary color, title text, and description.
- Manage on/off centrally — flip the toggle off and the widget stops responding everywhere it’s embedded.
The widget complements (rather than replaces) the per-order Client Portal tracking links you send to individual customers.
Enable / Disable
Section titled “Enable / Disable”A toggle at the top of the page turns the widget on or off globally:
- On — the widget responds to lookups everywhere it’s embedded.
- Off — the widget renders in a “currently unavailable” state.
Useful for maintenance windows, or for taking the widget offline if you decide to retire it.
Customization
Section titled “Customization”Below the toggle is a form with three fields:
| Field | Notes |
|---|---|
| Widget Title | Up to 255 characters. Shown as the heading inside the widget. “Track your order” or “Order status” is typical. |
| Widget Description | Up to 500 characters. A short subhead. “Enter your order number and email to see the current status.” |
| Primary Color | Dual control — a color picker and a hex text field, two-way bound. Drives the button, accents, and brand color inside the widget. |
Click Save to apply. The changes propagate to every embedded widget within seconds (the embed pulls the latest config on each load).
Embed code
Section titled “Embed code”Below the customization form is a read-only embed code block — a single <script> snippet with your widget_key and the embed_url.
- A Copy button copies the whole snippet to your clipboard. It briefly flashes “Copied!” to confirm.
- Paste the snippet into the HTML of any page on your website — typically near the bottom of the body, or in a CMS HTML block.
That’s it — once the snippet is on the page, the widget renders. Refreshing the page picks up your latest customization changes.
Preview
Section titled “Preview”A Show / Hide Preview button reveals a mock rendering of the widget in your current customization:
- Sample Order Number and Email inputs.
- A disabled Track button styled with your selected primary color.
The preview is purely visual — it doesn’t actually look up any order. Use it to sanity-check the title, description, and color before publishing.
The widget key
Section titled “The widget key”Each account has a single widget key — a stable identifier that the embed snippet uses to request your branding and data. The key:
- Is generated once when the account is created.
- Is immutable — you can’t change it through the UI.
- Is part of the embed snippet, baked into the script.
If you need to rotate the widget key (security incident, key leak), contact support.
Difference between Widget and Client Portal
Section titled “Difference between Widget and Client Portal”A common confusion:
| Widget | Client Portal | |
|---|---|---|
| Where it lives | On your website, as an embed. | On your Board, accessed via a unique tracking URL. |
| How a customer reaches it | Visits your website, types order # + email. | Clicks the tracking link you sent them. |
| Authentication | Order # + email (anyone with both can lookup). | Unique tracking token in the URL (anyone with the URL can view). |
| Per-order URL | No, single shared widget for all orders. | Yes, one URL per order. |
| Auto-refresh | On each page reload. | Auto-refreshes every 2 minutes while open. |
Most shops use both: the Widget for the “let customers find their own status” use case, the Client Portal link for proactive “here’s your tracking page” emails.
Tips and best practices
Section titled “Tips and best practices”- Embed in the footer or a dedicated “Track order” page. Don’t bury it deep in your site — the value is in being one click away.
- Match the primary color to your brand. The widget should feel like part of your site, not a foreign block dropped in.
- Keep the title direct. “Track your order” is clearer than “Order status checking utility”. Customers scan, they don’t read.
- The description sets expectations. “Enter your order number and email” tells the customer exactly what to do. Skip the marketing copy.
- Test the embed on multiple browsers. Some restrictive content security policies might block third-party scripts — the widget needs to be on your allow-list if you have CSP enabled.
- Toggle off during planned outages. The widget gracefully shows “currently unavailable” rather than throwing errors.
- Don’t share the widget key beyond the embed code. While it’s not a credential, anyone using it could request your account’s branding.