social.colibri.sync.subscribeHums

{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Egress-only WebSocket stream of Hums this AppView is relaying. Peers subscribe to receive off-protocol events for shared communities, optionally narrowing to declared `communities` (repeated query param). Requires inter-service auth (subprotocol-carried, as with subscribeEvents). Clients cannot send messages on this stream.",
      "errors": [
        {
          "name": "AuthRequired"
        },
        {
          "description": "Humming is disabled on this AppView.",
          "name": "NotEnabled"
        },
        {
          "description": "The hub is at its subscribeHums connection limit.",
          "name": "TooManySubscribers"
        }
      ],
      "message": {
        "schema": {
          "refs": [
            "lex:social.colibri.sync.subscribeEvents#humEnvelope"
          ],
          "type": "union"
        }
      },
      "parameters": {
        "properties": {
          "communities": {
            "description": "DIDs of the communities the peer wants Hums for, repeated once per community. Narrowing only: the intersection with what the peer is authorised for is what gets streamed, so declaring a community grants nothing. Omit it entirely to receive every authorised community.",
            "items": {
              "format": "did",
              "type": "string"
            },
            "type": "array"
          }
        },
        "type": "params"
      },
      "type": "subscription"
    }
  },
  "id": "social.colibri.sync.subscribeHums",
  "lexicon": 1
}