Report a step of the sign in window
Report a step of the sign in window: CustomDomain™ API reference in the cloud browser group. Covers parameters, request body, responses and error codes.
The popup reports one step of its window, for the sign in funnel: the sheet shown, a code or push prompt, a social sign in card, the typing overlay, the hand back for a password, the manual steps taken, the window closed. The control plane records it with the states it writes itself and counts it per provider. It changes nothing about the session and is not a heartbeat. detail is one short word (an sms, a google), never anything the customer typed, a page, an address or a URL: the closed alphabet refuses a space, a slash, a question mark, an equals sign and an at sign. A session that has ended still takes a step (the window closes after the end) while it answers its last view. At most 30 steps a minute per session. A navigator.sendBeacon cannot set headers, so, as for :cancel, the token may come in the body as token with a content type of text/plain or JSON.
Authorization
browserSession The session token of one cloud browser sign in, returned by POST /browser-sessions:redeem. It binds one session, one connection and one workspace, lives at most as long as the session, and stops working the moment the session ends. It lives in the popup's memory only.
In: header
Path Parameters
The cloud browser session id, bs_ and 32 hex characters.
TypeScript Definitions
Use the request body type in TypeScript.
One step of the cloud browser sign in window, reported by the popup.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/browser-sessions/string:event" \ -H "Content-Type: application/json" \ -d '{ "step": "sheet_shown" }'{ "code": "string", "title": "string", "details": "string"}{ "code": "string", "title": "string", "details": "string"}{ "code": "string", "title": "string", "details": "string"}{ "code": "string", "title": "string", "details": "string"}{ "code": "string", "title": "string", "details": "string"}