Skip to content

by Startups.Studio

Product Sites and apps Dashboard

Dashboard.schedule

POST /{namespace}/dashboards/{dashboard}/schedule

Schedule sends a Dashboard on a cadence to a Mailbox, a Channel or an Agent’s context, rendered for each.

Noun: Dashboard
Mode: do
Event: Dashboard.scheduled

You, to your agent

Schedule my dashboard.

curl -X POST https://api.sb/shiftnote.app/dashboards/dashboard_1/schedule \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"cadence":"daily","to":"Example to"}'

import { $ } from 'startup-builder'

const dashboard = await $.Dashboard.schedule({ dashboard: 'dashboard_1', cadence: 'daily', to: 'Example to' })

npx startup-builder do Dashboard.schedule --json '{"dashboard":"dashboard_1","cadence":"daily","to":"Example to"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Dashboard.schedule({ dashboard: 'dashboard_1', cadence: 'daily', to: 'Example to' })"
  }
}

Inputs

Input	Type	Required	Description
`dashboard`	Dashboard	required	The Dashboard to send.
`cadence`	`string`	required	How often it goes out.
`to`	`string`	required	The Mailbox, Channel or Agent that receives it.

Outputs

Output	Type	Required	Description
`dashboard`	Dashboard	required	The Dashboard, with its schedule.

Effects

Emits Dashboard.scheduled.
Performed by the Analyst.
Two-way: it runs at once, in the try, send and do modes.
Agents receive Markdown; Humans receive the rendered view.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Dashboard.schedule

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Dashboard.list

Previous Page

Dashboard.update

Next Page