embed

Mint a tenant-bound embed token

Short-lived, household-scoped, HMAC-signed token that lets the tenant's own site frame a real household through /embed/household/*. Growth plan; requires a configured domainAllowlist.

post/api/v1/embed-tokens

Request

  • Base URL: https://worthune.com
  • URL: https://worthune.com/api/v1/embed-tokens
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key

Request body

householdIdinteger required
widget'overview' | 'projection' | 'monte-carlo' | 'decisions' | 'lodestar-inbox' | 'lodestar-ledger' | 'lodestar-mandate-setup'

Binds the token to one widget. Household widgets are served at /embed/household/{widget}; "lodestar-inbox", "lodestar-ledger" and "lodestar-mandate-setup" at /embed/lodestar/{inbox|ledger|mandate-setup}. Omitted: any widget, and embedUrl names "overview".

expiresInSecondsinteger

Response

The token and a ready-to-frame URL.

okunknown required
tokenstring required
expiresAtstring date-time required
embedUrlstring uri required

Changes

No recorded changes to this operation across all 1 revision of this API.