chat.bsky.moderation.subscribeModEvents

Subscribe to stream of chat events targeted to moderation. Private endpoint.

class atproto_client.models.chat.bsky.moderation.subscribe_mod_events.Params

Bases: ParamsModelBase

Parameters model for chat.bsky.moderation.subscribeModEvents.

field cursor: str | None = None
class atproto_client.models.chat.bsky.moderation.subscribe_mod_events.ParamsDict

Bases: TypedDict

cursor: NotRequired[str | None]

The last known event seq number to backfill from. Use ‘2222222222222’ to backfill from the beginning. Don’t specify a cursor to listen only for new events.

class atproto_client.models.chat.bsky.moderation.subscribe_mod_events.EventConvoFirstMessage

Bases: ModelBase

Definition model for chat.bsky.moderation.subscribeModEvents. Fired when the first message was sent on a convo.

field convo_id: str [Required]

Convo id.

field created_at: DateTime [Required]

Created at.

field message_id: str | None = None

Message id.

field recipients: List[Did] [Required]

The list of DIDs message recipients. Does not include the sender, which is in the user field.

field rev: str [Required]

Rev.

field user: Did [Required]

The DID of the message author.

class atproto_client.models.chat.bsky.moderation.subscribe_mod_events.EventGroupChatCreated

Bases: ModelBase

Definition model for chat.bsky.moderation.subscribeModEvents. Fire when a group chat is created.

field actor_did: Did [Required]

The DID of the actor performing the action. For this event, same as ownerDid.

field convo_created_at: DateTime [Required]

When the group was originally created.

field convo_id: str [Required]

Convo id.

field created_at: DateTime [Required]

Created at.

field group_member_count: int [Required]

Current member count at the time of the event.

field group_name: str [Required]

The name set at creation time.

field initial_member_dids: List[Did] [Required]

DIDs of everyone added at creation time.

field owner_did: Did [Required]

The DID of the group chat owner.

field rev: str [Required]

Rev.

class atproto_client.models.chat.bsky.moderation.subscribe_mod_events.EventGroupChatMemberAdded

Bases: ModelBase

Definition model for chat.bsky.moderation.subscribeModEvents. Fired when a member is added to a group chat. Note that members are added in the ‘request’ state.

field actor_did: Did [Required]

The DID of the actor performing the action. For this event, same as ownerDid.

field convo_created_at: DateTime [Required]

When the group was originally created.

field convo_id: str [Required]

Convo id.

field created_at: DateTime [Required]

Created at.

field group_member_count: int [Required]

Current member count at the time of the event.

field group_name: str [Required]

Group name.

field owner_did: Did [Required]

The DID of the group chat owner.

field request_members_count: int [Required]

The number of members who have not yet accepted the convo.

field rev: str [Required]

Rev.

field subject_did: Did [Required]

The DID of the member who was added.

field subject_follows_owner: bool [Required]

Whether the added member follows the group owner.

class atproto_client.models.chat.bsky.moderation.subscribe_mod_events.EventGroupChatMemberJoined

Bases: ModelBase

Definition model for chat.bsky.moderation.subscribeModEvents. Fired when a member joins a group chat via an join link that does not require approval.

field actor_did: Did [Required]

The DID of the person joining.

field convo_created_at: DateTime [Required]

When the group was originally created.

field convo_id: str [Required]

Convo id.

field created_at: DateTime [Required]

Created at.

field group_member_count: int [Required]

Current member count at the time of the event.

field group_name: str [Required]

Group name.

The code of the join link used to join.

field owner_did: Did [Required]

The DID of the group chat owner.

field rev: str [Required]

Rev.

field subject_follows_owner: bool [Required]

Whether the joining member follows the group owner.

class atproto_client.models.chat.bsky.moderation.subscribe_mod_events.EventGroupChatJoinRequest

Bases: ModelBase

Definition model for chat.bsky.moderation.subscribeModEvents. Fired when a user requests to join a group chat via an join link that requires approval.

field actor_did: Did [Required]

The DID of the person requesting to join.

field convo_created_at: DateTime [Required]

When the group was originally created.

field convo_id: str [Required]

Convo id.

field created_at: DateTime [Required]

Created at.

field group_member_count: int [Required]

Current member count at the time of the event.

field group_name: str [Required]

Group name.

The code of the join link used to request joining.

field owner_did: Did [Required]

The DID of the group chat owner.

field rev: str [Required]

Rev.

field subject_follows_owner: bool [Required]

Whether the requesting member follows the group owner.

class atproto_client.models.chat.bsky.moderation.subscribe_mod_events.EventGroupChatJoinRequestApproved

Bases: ModelBase

Definition model for chat.bsky.moderation.subscribeModEvents. Fired when a join request is approved by the group owner.

field actor_did: Did [Required]

The DID of the owner approving the request.

field convo_created_at: DateTime [Required]

When the group was originally created.

field convo_id: str [Required]

Convo id.

field created_at: DateTime [Required]

Created at.

field group_member_count: int [Required]

Current member count at the time of the event.

field group_name: str [Required]

Group name.

field owner_did: Did [Required]

The DID of the group chat owner.

field rev: str [Required]

Rev.

field subject_did: Did [Required]

The DID of the member whose request was approved.

class atproto_client.models.chat.bsky.moderation.subscribe_mod_events.EventGroupChatJoinRequestRejected

Bases: ModelBase

Definition model for chat.bsky.moderation.subscribeModEvents. Fired when a join request is rejected by the group owner.

field actor_did: Did [Required]

The DID of the owner rejecting the request.

field convo_created_at: DateTime [Required]

When the group was originally created.

field convo_id: str [Required]

Convo id.

field created_at: DateTime [Required]

Created at.

field group_member_count: int [Required]

Current member count at the time of the event.

field group_name: str [Required]

Group name.

field owner_did: Did [Required]

The DID of the group chat owner.

field rev: str [Required]

Rev.

field subject_did: Did [Required]

The DID of the member whose request was rejected.

class atproto_client.models.chat.bsky.moderation.subscribe_mod_events.EventChatAccepted

Bases: ModelBase

Definition model for chat.bsky.moderation.subscribeModEvents. Fired when a user accepts a chat convo, either explicitly or by sending a message.

field actor_did: Did [Required]

The DID of the person accepting the convo.

field convo_created_at: DateTime [Required]

When the convo was originally created.

field convo_id: str [Required]

Convo id.

field created_at: DateTime [Required]

Created at.

field group_member_count: int | None = None
field group_name: str | None = None

The name of the group chat. Only present for group convos.

field method: Literal['explicit', 'message'] | str [Required]

How the convo was accepted.

field owner_did: Did | None = None

The DID of the group chat owner. Only present for group convos.

field rev: str [Required]

Rev.

class atproto_client.models.chat.bsky.moderation.subscribe_mod_events.EventGroupChatMemberLeft

Bases: ModelBase

Definition model for chat.bsky.moderation.subscribeModEvents. Fired when a member leaves or is removed from a group chat.

field actor_did: Did [Required]

The DID of the actor. For voluntary: the person leaving. For kicked: the owner.

field convo_created_at: DateTime [Required]

When the group was originally created.

field convo_id: str [Required]

Convo id.

field created_at: DateTime [Required]

Created at.

field group_member_count: int [Required]

Current member count at the time of the event.

field group_name: str [Required]

Group name.

field leave_method: Literal['voluntary', 'kicked'] | str [Required]

How the member left.

field owner_did: Did [Required]

The DID of the group chat owner.

field rev: str [Required]

Rev.

field subject_did: Did [Required]

The DID of the member who left or was removed.

class atproto_client.models.chat.bsky.moderation.subscribe_mod_events.EventGroupChatUpdated

Bases: ModelBase

Definition model for chat.bsky.moderation.subscribeModEvents. Fired when a group chat’s metadata or status changes.

field actor_did: Did [Required]

The DID of the actor performing the action (the owner).

field convo_created_at: DateTime [Required]

When the group was originally created.

field convo_id: str [Required]

Convo id.

field created_at: DateTime [Required]

Created at.

field group_member_count: int [Required]

Current member count at the time of the event.

field group_name: str [Required]

Current group name.

field lock_reason: Literal['owner_action', 'owner_left', 'owner_deactivated', 'owner_deleted', 'owner_suspended', 'owner_taken_down', 'label_applied', 'convo_taken_down'] | str | None = None

Why the group was locked. Only present when updateType is ‘locked’.

field new_name: str | None = None

The new group name. Only present when updateType is ‘name_changed’.

field old_name: str | None = None

The previous group name. Only present when updateType is ‘name_changed’.

field owner_did: Did [Required]

The DID of the group chat owner.

field rev: str [Required]

Rev.

field update_type: Literal['name_changed', 'locked', 'locked_permanently', 'unlocked', 'join_link_created', 'join_link_disabled', 'join_link_settings_changed'] | str [Required]

What changed.

class atproto_client.models.chat.bsky.moderation.subscribe_mod_events.EventRateLimitExceeded

Bases: ModelBase

Definition model for chat.bsky.moderation.subscribeModEvents. Fired when a user exceeds a rate limit.

field actor_did: Did [Required]

The DID of the user who hit the rate limit.

field created_at: DateTime [Required]

Created at.

field endpoint: str [Required]

The NSID of the endpoint that was rate limited.

field rev: str [Required]

Rev.