social.colibri.sync.subscribeEvents

colibri.social

Documentation

Opens a WebSocket stream that transmits relevant events for the authenticated user.

main subscription

Opens a WebSocket stream that transmits relevant events for the authenticated user.

Message Types

Open union
lex:social.colibri.sync.subscribeEvents#ack lex:social.colibri.sync.subscribeEvents#communityEvent lex:social.colibri.sync.subscribeEvents#memberEvent lex:social.colibri.sync.subscribeEvents#categoryEvent lex:social.colibri.sync.subscribeEvents#channelEvent lex:social.colibri.sync.subscribeEvents#messageEvent lex:social.colibri.sync.subscribeEvents#reactionEvent lex:social.colibri.sync.subscribeEvents#userEvent lex:social.colibri.sync.subscribeEvents#typingEvent

Errors

AuthRequired
View raw schema 
{
  "type": "subscription",
  "errors": [
    {
      "name": "AuthRequired"
    }
  ],
  "message": {
    "schema": {
      "refs": [
        "lex:social.colibri.sync.subscribeEvents#ack",
        "lex:social.colibri.sync.subscribeEvents#communityEvent",
        "lex:social.colibri.sync.subscribeEvents#memberEvent",
        "lex:social.colibri.sync.subscribeEvents#categoryEvent",
        "lex:social.colibri.sync.subscribeEvents#channelEvent",
        "lex:social.colibri.sync.subscribeEvents#messageEvent",
        "lex:social.colibri.sync.subscribeEvents#reactionEvent",
        "lex:social.colibri.sync.subscribeEvents#userEvent",
        "lex:social.colibri.sync.subscribeEvents#typingEvent"
      ],
      "type": "union"
    }
  },
  "description": "Opens a WebSocket stream that transmits relevant events for the authenticated user."
}
ack object

Sent in response to a heartbeat message.

Properties

type string Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "type": "string",
      "const": "ack"
    }
  },
  "description": "Sent in response to a heartbeat message."
}
categoryEvent object

Sent when a category has been created, updated, or deleted.

Properties

type string Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "type",
    "data"
  ],
  "properties": {
    "data": {
      "ref": "lex:social.colibri.sync.subscribeEvents#categoryEventData",
      "type": "ref"
    },
    "type": {
      "type": "string",
      "const": "category_event"
    }
  },
  "description": "Sent when a category has been created, updated, or deleted."
}
categoryEventData object

No description available.

Properties

channelOrder array of string Optional

No description available.

community string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

event string Required

No description available.

Known values: upsert, delete
name string Optional

No description available.

uri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema 
{
  "type": "object",
  "required": [
    "event",
    "uri",
    "community"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "name": {
      "type": "string"
    },
    "event": {
      "type": "string",
      "knownValues": [
        "upsert",
        "delete"
      ]
    },
    "community": {
      "type": "string",
      "format": "at-uri"
    },
    "channelOrder": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
channelEvent object

Sent when a channel has been created, updated, or deleted.

Properties

type string Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "type",
    "data"
  ],
  "properties": {
    "data": {
      "ref": "lex:social.colibri.sync.subscribeEvents#channelEventData",
      "type": "ref"
    },
    "type": {
      "type": "string",
      "const": "channel_event"
    }
  },
  "description": "Sent when a channel has been created, updated, or deleted."
}
channelEventData object

No description available.

Properties

community string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

description string Optional

No description available.

event string Required

No description available.

Known values: upsert, delete
name string Optional

No description available.

type string Optional

No description available.

uri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema 
{
  "type": "object",
  "required": [
    "event",
    "uri",
    "community"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "name": {
      "type": "string"
    },
    "type": {
      "type": "string"
    },
    "event": {
      "type": "string",
      "knownValues": [
        "upsert",
        "delete"
      ]
    },
    "community": {
      "type": "string",
      "format": "at-uri"
    },
    "description": {
      "type": "string"
    }
  }
}
communityEvent object

Sent when a community has been updated or deleted.

Properties

type string Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "type",
    "data"
  ],
  "properties": {
    "data": {
      "ref": "lex:social.colibri.sync.subscribeEvents#communityEventData",
      "type": "ref"
    },
    "type": {
      "type": "string",
      "const": "community_event"
    }
  },
  "description": "Sent when a community has been updated or deleted."
}
communityEventData object

No description available.

Properties

categoryOrder array of string Optional

No description available.

description string Optional

No description available.

event string Required

No description available.

Known values: upsert, delete
name string Optional

No description available.

picture blob Optional

No description available.

uri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema 
{
  "type": "object",
  "required": [
    "event",
    "uri"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "name": {
      "type": "string"
    },
    "event": {
      "type": "string",
      "knownValues": [
        "upsert",
        "delete"
      ]
    },
    "picture": {
      "type": "blob"
    },
    "description": {
      "type": "string"
    },
    "categoryOrder": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
memberEvent object

Sent when a member has joined or left a community.

Properties

type string Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "type",
    "data"
  ],
  "properties": {
    "data": {
      "ref": "lex:social.colibri.sync.subscribeEvents#memberEventData",
      "type": "ref"
    },
    "type": {
      "type": "string",
      "const": "member_event"
    }
  },
  "description": "Sent when a member has joined or left a community."
}
memberEventData object

No description available.

Properties

community string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

event string Required

No description available.

Known values: join, leave
membership string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema 
{
  "type": "object",
  "required": [
    "event",
    "community",
    "membership"
  ],
  "properties": {
    "event": {
      "type": "string",
      "knownValues": [
        "join",
        "leave"
      ]
    },
    "community": {
      "type": "string",
      "format": "at-uri"
    },
    "membership": {
      "type": "string",
      "format": "at-uri"
    }
  }
}
messageEvent object

Sent when a message has been sent, edited, or deleted.

Properties

type string Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "type",
    "data"
  ],
  "properties": {
    "data": {
      "ref": "lex:social.colibri.sync.subscribeEvents#messageEventData",
      "type": "ref"
    },
    "type": {
      "type": "string",
      "const": "message_event"
    }
  },
  "description": "Sent when a message has been sent, edited, or deleted."
}
messageEventData object

No description available.

Properties

attachments array of blob Optional

No description available.

channel string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

createdAt string datetime Optional

An RFC 3339 formatted timestamp.

edited boolean Optional

No description available.

event string Required

No description available.

Known values: upsert, delete
indexedAt string datetime Optional

An RFC 3339 formatted timestamp.

parent string at-uri Optional

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

text string Optional

No description available.

uri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema 
{
  "type": "object",
  "required": [
    "event",
    "uri",
    "channel"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "text": {
      "type": "string"
    },
    "event": {
      "type": "string",
      "knownValues": [
        "upsert",
        "delete"
      ]
    },
    "edited": {
      "type": "boolean"
    },
    "facets": {
      "type": "array",
      "items": {
        "ref": "lex:social.colibri.richtext.facet",
        "type": "ref"
      }
    },
    "parent": {
      "type": "string",
      "format": "at-uri"
    },
    "channel": {
      "type": "string",
      "format": "at-uri"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    },
    "indexedAt": {
      "type": "string",
      "format": "datetime"
    },
    "attachments": {
      "type": "array",
      "items": {
        "type": "blob"
      }
    }
  }
}
reactionEvent object

Sent when a reaction has been added to or removed from a message.

Properties

type string Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "type",
    "data"
  ],
  "properties": {
    "data": {
      "ref": "lex:social.colibri.sync.subscribeEvents#reactionEventData",
      "type": "ref"
    },
    "type": {
      "type": "string",
      "const": "reaction_event"
    }
  },
  "description": "Sent when a reaction has been added to or removed from a message."
}
reactionEventData object

No description available.

Properties

channel string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

emoji string Required

No description available.

event string Required

No description available.

Known values: added, removed
target string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

uri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema 
{
  "type": "object",
  "required": [
    "event",
    "uri",
    "emoji",
    "target",
    "channel"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "emoji": {
      "type": "string"
    },
    "event": {
      "type": "string",
      "knownValues": [
        "added",
        "removed"
      ]
    },
    "target": {
      "type": "string",
      "format": "at-uri"
    },
    "channel": {
      "type": "string",
      "format": "at-uri"
    }
  }
}
typingEvent object

Sent when a user is typing in a channel the client is viewing.

Properties

type string Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "type",
    "data"
  ],
  "properties": {
    "data": {
      "ref": "lex:social.colibri.sync.subscribeEvents#typingEventData",
      "type": "ref"
    },
    "type": {
      "type": "string",
      "const": "typing_event"
    }
  },
  "description": "Sent when a user is typing in a channel the client is viewing."
}
typingEventData object

No description available.

Properties

channel string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

did string did Required

A decentralized identifier (DID).

event string Required

No description available.

Known values: start, stop
View raw schema 
{
  "type": "object",
  "required": [
    "event",
    "channel",
    "did"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did"
    },
    "event": {
      "type": "string",
      "knownValues": [
        "start",
        "stop"
      ]
    },
    "channel": {
      "type": "string",
      "format": "at-uri"
    }
  }
}
userEvent object

Sent when a known user has updated their profile or Colibri status.

Properties

type string Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "type",
    "data"
  ],
  "properties": {
    "data": {
      "ref": "lex:social.colibri.sync.subscribeEvents#userEventData",
      "type": "ref"
    },
    "type": {
      "type": "string",
      "const": "user_event"
    }
  },
  "description": "Sent when a known user has updated their profile or Colibri status."
}
userEventData object

No description available.

Properties

did string did Required

A decentralized identifier (DID).

View raw schema 
{
  "type": "object",
  "required": [
    "did",
    "profile"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did"
    },
    "status": {
      "ref": "lex:social.colibri.sync.subscribeEvents#userStatus",
      "type": "ref"
    },
    "profile": {
      "ref": "lex:social.colibri.sync.subscribeEvents#userProfile",
      "type": "ref"
    }
  }
}
userProfile object

No description available.

Properties

avatar blob Optional

No description available.

banner blob Optional

No description available.

description string Optional

No description available.

displayName string Optional

No description available.

handle string handle Required

An AT Protocol handle (e.g., alice.bsky.social).

View raw schema 
{
  "type": "object",
  "required": [
    "handle"
  ],
  "properties": {
    "avatar": {
      "type": "blob"
    },
    "banner": {
      "type": "blob"
    },
    "handle": {
      "type": "string",
      "format": "handle"
    },
    "description": {
      "type": "string"
    },
    "displayName": {
      "type": "string"
    }
  }
}
userStatus object

No description available.

Properties

emoji string Optional

No description available.

state string Required

No description available.

Known values: online, away, dnd, offline
text string Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "state",
    "text"
  ],
  "properties": {
    "text": {
      "type": "string"
    },
    "emoji": {
      "type": "string"
    },
    "state": {
      "type": "string",
      "knownValues": [
        "online",
        "away",
        "dnd",
        "offline"
      ]
    }
  }
}

Lexicon Garden

@