Skip to main content
POST
The onboarding canvas's own button takes one of the way in's asks for this room as it posts the ask's line: records the take once, and ends the way in as done when it filled the last place. An ask already taken, or a way in that has ended, changes nothing.

Authorizations

Authorization
string
header
required

A WorkOS-dashboard-issued internal API key on Authorization: Bearer.

Body

application/json
ask
string
required

The id of the ask the tapped button carries.

Pattern: ^[a-z][a-z0-9_]{0,63}$

Response

Success. request_id is present on every response.

taken
boolean
required

Whether this call recorded the take; false when the ask was already taken or the way in had ended.

onboarding
object
required

This room's place on the way in, as data, on every answer while it is open. step is the last step this room reached, null before its first card; done and ended_by say whether and how it ended (skip, question or done). While next is present, render next.card through dally_show, saying say first, as written, when it is present. After the onboarding_canvas card the way in runs itself: the card's buttons record their own progress, so answer the creator as usual; before that card, a real question ends the way in. skip names the write that ends the way in, onboarding.skip, and follow_up the line a creator who already knows Dally says; when they say it, call onboarding.skip.

show
object
required

How it is shown: the onboarding canvas, which reads its own count.

request_id
string
required

Server-minted id for this request. Present on every response, success and error — quote it when reporting a problem.

Minimum string length: 1