—embed::status

Manage status embed widgets — lightweight, embeddable widgets that show a heartbeat status on any external site or dashboard.

Syntax

--embed::status
--embed::status:create
--embed::status:create:<name>
--embed::status:<name>
--embed::status:<name>:edit
--embed::status:<name>:delete

Sub-commands

CommandDescription
--embed::statusList all embed widgets for the project
--embed::status:createOpen the widget creation form
--embed::status:create:<name>Create a widget with a pre-filled name
--embed::status:<name>View details for a named widget
--embed::status:<name>:editEdit a named widget
--embed::status:<name>:deleteDelete a named widget

Examples

--embed::status
--embed::status:create:api-status
--embed::status:api-status
--embed::status:api-status:edit
--embed::status:api-status:delete

Widget configuration

Each widget is configured with:

  • Name — identifier for the widget
  • Allowed origin — the domain allowed to display the embed (e.g. https://yoursite.com)
  • Heartbeat timeout — minutes before the widget shows as degraded (2–5 minutes)
  • Notify on heartbeat — optionally fire a notification when a heartbeat is missed
  • Notification integration — which integration to notify (Slack, Discord, etc.)
  • Notify channel — specific channel to post to

Plan requirements

Embed widget creation requires the Solo plan or higher.

Notes

  • Each widget gets a unique token used for authentication
  • Tokens are scoped to a single allowed origin for security
  • Scope: project