social.colibri.beta.bridge.redeemPairing

colibri.social

Documentation

Connects a bridge to a community by redeeming its pairing code. Writes a registration with no linked channels.

main procedure

Connects a bridge to a community by redeeming its pairing code. Writes a registration with no linked channels.

Input

Encodingapplication/json
code string Required

The pairing code.

maxLength: 32 bytes
community stringdid Required

The community to connect the bridge to.

Output

Encodingapplication/json

Errors

AuthRequired The request is missing, malformed, or unverifiable service auth.
Forbidden The caller lacks the community.manage permission.
CommunityNotFound No community exists at the given DID.
PairingNotFound The code does not exist, has expired, or was already used.
AlreadyRegistered This bridge is already connected to the same remote space in this community.
CredentialsUnavailable The AppView cannot act as the community because its stored credentials are missing or unusable.
Try It

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

Base URL for XRPC calls (e.g., https://bsky.social)
Enter valid JSON for the request body
View raw schema 
{
  "description": "Connects a bridge to a community by redeeming its pairing code. Writes a registration with no linked channels.",
  "errors": [
    {
      "description": "The request is missing, malformed, or unverifiable service auth.",
      "name": "AuthRequired"
    },
    {
      "description": "The caller lacks the community.manage permission.",
      "name": "Forbidden"
    },
    {
      "description": "No community exists at the given DID.",
      "name": "CommunityNotFound"
    },
    {
      "description": "The code does not exist, has expired, or was already used.",
      "name": "PairingNotFound"
    },
    {
      "description": "This bridge is already connected to the same remote space in this community.",
      "name": "AlreadyRegistered"
    },
    {
      "description": "The AppView cannot act as the community because its stored credentials are missing or unusable.",
      "name": "CredentialsUnavailable"
    }
  ],
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "code": {
          "description": "The pairing code.",
          "maxLength": 32,
          "type": "string"
        },
        "community": {
          "description": "The community to connect the bridge to.",
          "format": "did",
          "type": "string"
        }
      },
      "required": [
        "community",
        "code"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "registration": {
          "description": "The registration.",
          "ref": "social.colibri.beta.bridge.defs#registrationView",
          "type": "ref"
        }
      },
      "required": [
        "registration"
      ],
      "type": "object"
    }
  },
  "type": "procedure"
}

Lexicon Garden

@