button

One link that starts the next step, to a screen of this app or a URL, such as Build an agent.

label is the words on the button (a verb first); to names a screen of this app, or href an https:// URL or a path starting with /; exactly one of the two. emphasis is primary (the one main step on a screen), secondary (the default) or quiet. icon names an icon shown before the label. A button only navigates; it never writes.

When to use

Use it when

The next step from a screen, such as building an agent from the agents screen.
A link out to a document, such as the runbook or a schema.
A way back, such as back to the queue from a ticket.

Use another block when

A change to the selected rows, such as closing tickets.
Use grid
Saving what a person typed.
Use form
Several links, one per line.
Use list

The main step on a screen

Build an agent

button: { label: Build an agent, to: build-agent, emphasis: primary, icon: plus }

<a id="button-1"></a>

[Build an agent](/a/catalog/build-agent)

- #button-1.open "Build an agent": GET /a/catalog/build-agent · opens the screen · approval: no · cost: free

A link to a runbook

Open the VPN runbook

button: { label: Open the VPN runbook, href: 'https://docs.example.com/runbooks/vpn', icon: file }

<a id="button-1"></a>

[Open the VPN runbook](https://docs.example.com/runbooks/vpn)

A quiet way back

Back to the queue

button:
  label: Back to the queue
  to: queue
  emphasis: quiet

<a id="button-1"></a>

[Back to the queue](/a/catalog/queue)

- #button-1.open "Back to the queue": GET /a/catalog/queue · opens the screen · approval: no · cost: free

States

ready
always drawn; it reads no data

Action	Needs	Does	Reversible	Confirm page	Cost
open	none	navigates to the screen	yes	never	free

JSON Schema