dev.jazco.boards.indexBoard Documentation (EN)

main procedure

Ask the appview to index a board. Its owner first adds the appview's account as a read-only member; the appview then registers for the board's notifies and syncs it. Owner auth: a space credential issued to the board's owner.

Input

Encodingapplication/json

board stringuri Required

A valid URI.

Output

Encodingapplication/json

board stringuri Required

A valid URI.

spaceRev string Optional

No description available.

Errors

NotAMember The appview's account can't get a credential for the board.

AuthRequired

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://bsky.social)

Request Body (JSON) Enter valid JSON for the request body

View raw schema

{
  "description": "Ask the appview to index a board. Its owner first adds the appview's account as a read-only member; the appview then registers for the board's notifies and syncs it. Owner auth: a space credential issued to the board's owner.",
  "errors": [
    {
      "description": "The appview's account can't get a credential for the board.",
      "name": "NotAMember"
    },
    {
      "name": "AuthRequired"
    }
  ],
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "board": {
          "format": "uri",
          "type": "string"
        }
      },
      "required": [
        "board"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "board": {
          "format": "uri",
          "type": "string"
        },
        "spaceRev": {
          "type": "string"
        }
      },
      "required": [
        "board"
      ],
      "type": "object"
    }
  },
  "type": "procedure"
}