A valid request URL is required to generate request examples{
"step": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"key": "<string>",
"title": "<string>",
"kind": "event",
"event_type": "<string>",
"feature_key": "<string>",
"action_url": "<string>",
"action_label": "<string>",
"hint_pending": "<string>",
"hint_done": "<string>",
"position": 123,
"sightings": 123,
"last_seen": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Rename or reorder a step
Requires engagement:manage. The title and the position, and nothing else.
kind, event_type, feature_key and key are deliberately not editable: changing what a step means while people hold progress against it would leave rows saying “satisfied” for a rule that no longer exists, and nothing could tell which of them still qualify. Re-aiming a step is deleting it and adding another — which loses the progress out loud instead of quietly keeping the wrong number.
A valid request URL is required to generate request examples{
"step": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"key": "<string>",
"title": "<string>",
"kind": "event",
"event_type": "<string>",
"feature_key": "<string>",
"action_url": "<string>",
"action_label": "<string>",
"hint_pending": "<string>",
"hint_done": "<string>",
"position": 123,
"sightings": 123,
"last_seen": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Authorizations
A staff session token, uk_st_…. Minted by sign-up, sign-in or the two-factor exchange. Only a 401 means it is spent; not_a_member (403) is about the organization named in X-Organization-Id and leaves the token good for the others.
Headers
The organization the caller is acting on — the org_… code that appears in the panel URL. It identifies; the membership JOIN is what authorizes, so a forged code reads nothing: the answer is not_a_member (403), which does not mean the session is over. Absent, the session's default organization answers, or — if that membership was revoked while the session was open — any other one the caller still holds.
Body
What a step SAYS and where it SENDS somebody. What satisfies it — kind, event_type, feature_key — is deliberately absent: people hold progress against this step, and changing its meaning would leave rows claiming they did something nobody asked of them. Re-aiming a step is deleting it and adding another. A destination carries none of that weight, so a wrong link is fixed here.
200Optional. Where the line sends somebody when they click it: a path starting with / (your own app) or an absolute http(s) URL.
Clicking never satisfies a step — kind decides that. A step with no destination is a line the reader has to go find the screen for themselves.
An explicit empty string removes it. Absent leaves it alone.
2048Optional. The word on the control; without it the step's title becomes the link. Set alone, with no action_url, it declares an action your own page handles through the SDK's onStepAction — a control that does nothing until you wire that callback.
An explicit empty string removes it. Absent leaves it alone.
40What it says on hover while it is NOT done — a reason or an instruction the title has no room for.
Two texts and not one because the same line means different things before and after: pending, the useful sentence is an instruction; done, an instruction is noise and what is useful is what it bought. A single field would force a sentence that is wrong half the time.
200What it says on hover once it IS done. Null is the common case and reads correctly — nothing on hover about a thing somebody already did.
200Response
The step as it now stands.
One line of the list. kind decides which of event_type and feature_key carries the rule; the other is always null. action_url and action_label are what happens when somebody clicks it, and neither has anything to do with what satisfies it.
Show child attributes
Show child attributes