site.exosphere.kanban.status Documentation (EN)

main record

A status change on a kanban task, published on the actor's PDS. Third-party indexers can replay these to derive the current column of a task.

Record Key tid Timestamp-based ID

Properties

status string Required

Column slug the task is moved to. Values are user-defined per Sphere.

maxLength: 128 bytes

Known values: backlog, todo, in-progress, done

statusType string Required

Canonical status type the column maps to. Third-party indexers use this to categorize user-defined slugs without needing the sphere's column config.

Known values: backlog, planned, started, completed, canceled

subject string at-uri Required

AT URI of the kanban task whose status is being changed.

View raw schema

{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "subject",
      "status",
      "statusType"
    ],
    "properties": {
      "status": {
        "type": "string",
        "maxLength": 128,
        "description": "Column slug the task is moved to. Values are user-defined per Sphere.",
        "knownValues": [
          "backlog",
          "todo",
          "in-progress",
          "done"
        ]
      },
      "subject": {
        "type": "string",
        "format": "at-uri",
        "description": "AT URI of the kanban task whose status is being changed."
      },
      "statusType": {
        "type": "string",
        "description": "Canonical status type the column maps to. Third-party indexers use this to categorize user-defined slugs without needing the sphere's column config.",
        "knownValues": [
          "backlog",
          "planned",
          "started",
          "completed",
          "canceled"
        ]
      }
    }
  },
  "description": "A status change on a kanban task, published on the actor's PDS. Third-party indexers can replay these to derive the current column of a task."
}