social.colibri.beta.bridge.createPairing

colibri.social

Documentation

Starts pairing a bridge with a community. Called by the bridge, which shows the returned code to an admin on the other service. A Colibri admin then redeems the code, which proves both sides agreed.

main procedure

Starts pairing a bridge with a community. Called by the bridge, which shows the returned code to an admin on the other service. A Colibri admin then redeems the code, which proves both sides agreed.

Input

Encodingapplication/json
platform string Required

The service the bridge connects to.

maxLength: 64 bytes
remoteSpace string Required

The id of the server, workspace or network on the other service.

maxLength: 256 bytes
remoteSpaceName string Required

Its name on the other service.

maxLength: 128 bytes

Output

Encodingapplication/json
code string Required

The single-use pairing code.

expiresAt stringdatetime Required

When the code stops working.

Errors

AuthRequired The request is missing, malformed, or unverifiable service auth.
RateLimited The bridge sent too many requests. Retry after the interval in the response headers.
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": "Starts pairing a bridge with a community. Called by the bridge, which shows the returned code to an admin on the other service. A Colibri admin then redeems the code, which proves both sides agreed.",
  "errors": [
    {
      "description": "The request is missing, malformed, or unverifiable service auth.",
      "name": "AuthRequired"
    },
    {
      "description": "The bridge sent too many requests. Retry after the interval in the response headers.",
      "name": "RateLimited"
    }
  ],
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "platform": {
          "description": "The service the bridge connects to.",
          "maxLength": 64,
          "type": "string"
        },
        "remoteSpace": {
          "description": "The id of the server, workspace or network on the other service.",
          "maxLength": 256,
          "type": "string"
        },
        "remoteSpaceName": {
          "description": "Its name on the other service.",
          "maxLength": 128,
          "type": "string"
        }
      },
      "required": [
        "platform",
        "remoteSpace",
        "remoteSpaceName"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "code": {
          "description": "The single-use pairing code.",
          "maxLength": 32,
          "type": "string"
        },
        "expiresAt": {
          "description": "When the code stops working.",
          "format": "datetime",
          "type": "string"
        }
      },
      "required": [
        "code",
        "expiresAt"
      ],
      "type": "object"
    }
  },
  "type": "procedure"
}

Lexicon Garden

@