---
title: "Record a sign-in step"
method: POST
path: "/v1/web-recorder/{sid}/action"
tags: ["web-recorder"]
---

# Record a sign-in step

`POST /v1/web-recorder/{sid}/action`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/web-recorder/{sid}/action`
- Auth: HTTP bearer

Append one recorded interaction, such as a click, typed text, or a wait, to an open sign-in recording session.

## Path parameters

- `sid` string, required

## Request body

- object: One browser action.
  - `kind` 'click' | 'type' | 'scroll' | 'navigate' | 'accept-cookies' | 'wait' | 'pick', required
  - `selector` string
  - `label` string
  - `text` string: For `type`: the typed text (not stored when `isSecret`).
  - `isSecret` boolean: For `type`: store a reference instead of the text.
  - `url` string
  - `dy` number
  - `ms` number
  - `mode` string
  - `x` number
  - `y` number

## Response `200`

Success.

- object
  - `data` object, required
    - `url` string, required: The page the recording is on now.
    - `steps` RecordedStep[], required
      - `kind` string, required: `navigate`, `click`, `enter-text`, `scroll`, `accept-cookies`, `wait`, or a picker step.
      - `url` string
      - `selector` string
      - `label` string
      - `value` string: Typed text that is not secret.
      - `valueRef` string: For secret text: a reference; the value is never recorded. Send it in `finalize`'s `secrets`.
      - `pixels` number
      - `ms` number
    - `startedAt` integer, required: Milliseconds since the Unix epoch (not an ISO timestamp).
    - `spaceId` string, required

## Other responses

- `400`: The body is not JSON.
- `401`: Missing, expired or revoked bearer token.
- `403`: The token lacks the permission this operation needs (see `x-brix-permission`).
- `404`: No active session with this id in this workspace (it expired, was finished, or never started).
- `503`: Recording is not available in this environment.
- `5XX`: Server error. The body carries a `requestId` to quote to support.

---

[API](https://skmtc.dev/brixsignage/apis/brix-api.md) · [All operations](https://skmtc.dev/brixsignage/apis/brix-api/llms.txt) · [OpenAPI document](https://skmtc.dev/brixsignage/apis/brix-api/revisions/02fd3665dc7d?raw)