# Sendbird Sendbird is a platform that provides chat, voice, and video APIs to help businesses build in-app communication features. - **Category:** communication - **Auth:** API_KEY - **Composio Managed App Available?** N/A - **Tools:** 37 - **Triggers:** 0 - **Slug:** `SENDBIRD` - **Version:** 20260410_00 ## Tools ### Add Members To Group Channel **Slug:** `SENDBIRD_ADD_MEMBERS_GROUP_CHANNEL` Tool to add members to a group channel. Use when you need to invite one or more users into an existing group channel. ### Ban User from Group Channel **Slug:** `SENDBIRD_BAN_USER_FROM_GROUP_CHANNEL` Tool to ban a user from a group channel. Use when moderating group channels to restrict member access. Execute after confirming channel_url and user_id. ### Create Group Channel **Slug:** `SENDBIRD_CREATE_CHANNEL` Tool to create a new group channel. Use when you need to start a conversation with specific users. Execute after specifying users and optional settings. ### Create Sendbird User **Slug:** `SENDBIRD_CREATE_USER` Creates a new user in Sendbird. Use this to register user accounts before they can join channels or send messages. The user_id must be unique across the application. ### Delete Group Channel **Slug:** `SENDBIRD_DELETE_CHANNEL` Permanently deletes a Sendbird group channel. Use this tool when you need to remove a group channel and all its associated data (messages, members, etc.). WARNING: This action is irreversible. Requires the channel_url identifier of the channel to delete. ### Delete Message **Slug:** `SENDBIRD_DELETE_MESSAGE` Permanently deletes a specific message from a Sendbird group channel. This action cannot be undone. Use this when you need to remove a message that was sent by mistake or contains inappropriate content. Requires both channel_url and message_id, which can be obtained from channel/message listing endpoints. ### Delete Sendbird User **Slug:** `SENDBIRD_DELETE_USER` Tool to delete a Sendbird user. Use when you need to remove a user from your Sendbird application, optionally permanently. ### Get Count Preference Of Channel **Slug:** `SENDBIRD_GET_COUNT_PREFERENCE_OF_CHANNEL` Tool to retrieve a user's count preference for a specific group channel. Use after confirming the user and channel exist to determine whether to display all, unread-only, or mention-only counts. ### Get User Group Channel Count by Join Status **Slug:** `SENDBIRD_GET_NUMBER_OF_CHANNELS_BY_JOIN_STATUS` Retrieves the number of group channels for a user, categorized by join status (joined, invited, etc.). Use this tool to get channel count statistics for a specific user, optionally filtered by channel properties like visibility (public/private), distinctness, or super mode. Returns counts of joined channels, invited channels (with friend/non-friend breakdown), and total count. ### Sendbird Get Unread Item Count **Slug:** `SENDBIRD_GET_NUMBER_OF_UNREAD_ITEMS` Tool to retrieve a user's unread item counts including unread messages, mentions, and pending invitations across group channels. Use this to display unread counts in the UI for a specific user. ### Issue Session Token **Slug:** `SENDBIRD_ISSUE_SESSION_TOKEN` Issues a session token for authenticating a Sendbird user. Use this tool when you need to: - Generate a new session token for SDK authentication - Refresh an expiring or expired session token - Provide secure access for a user to connect to Sendbird chat The session token has a default expiration of 7 days if expires_at is not specified. ### Leave Group Channels **Slug:** `SENDBIRD_LEAVE_GROUP_CHANNELS` Tool to leave group channels for a user. Use when you need to make a user exit one or more joined group channels. ### List Banned Members **Slug:** `SENDBIRD_LIST_BANNED_MEMBERS` Tool to list banned members in a group channel. Use when you need to see which users are banned from a specific group channel. ### Sendbird List Group Channel Messages **Slug:** `SENDBIRD_LIST_GROUP_CHANNEL_MESSAGES` Tool to list (paginate) messages in a group channel when you only know the channel_url. Requires either message_ts (Unix ms timestamp) or message_id as an anchor. Use with SENDBIRD_VIEW_GROUP_CHANNEL (show_read_receipt=true) to fetch unread messages: get last-read timestamp, then call this with message_ts=, prev_limit=0, next_limit=, include=false. ### List Group Channels **Slug:** `SENDBIRD_LIST_GROUP_CHANNELS` Tool to list group channels. Use when you need to fetch paginated group channels with optional filters. ### List Group Channel Members **Slug:** `SENDBIRD_LIST_MEMBERS_GROUP_CHANNEL` Tool to list members of a group channel. Use when you need to paginate through members of a specified group channel. ### List Operators by Custom Channel Type **Slug:** `SENDBIRD_LIST_OPERATORS_CUSTOM_CHANNEL_TYPE` Tool to list operators of a channel by custom channel type. Use when you need to fetch operators for a specific custom channel type with pagination. ### List Group Channel Operators **Slug:** `SENDBIRD_LIST_OPERATORS_GROUP_CHANNEL` Tool to list operators of a group channel. Use after specifying the channel_url when needing to paginate through operators. ### List Open Channel Operators **Slug:** `SENDBIRD_LIST_OPERATORS_OPEN_CHANNEL` Tool to list operators of an open channel. Use when you have the open channel URL and need to fetch its operators. Supports pagination via token and limit. ### List Sendbird Users **Slug:** `SENDBIRD_LIST_USERS` Retrieves a paginated list of users from your Sendbird application. Use this tool to: - Browse all users in your application - Search for users by nickname or user IDs - Filter users by metadata, custom type, or activity status - Paginate through large user lists using the 'next' token Returns user details including profile info, connection status, and metadata. Results are paginated; use the 'next' token from the response to fetch additional pages. ### Mark All User Messages As Read **Slug:** `SENDBIRD_MARK_ALL_USER_MESSAGES_AS_READ` Tool to mark all of a user's messages as read in group channels. Use when resetting unread message counts after a user has viewed all messages. ### Mute User **Slug:** `SENDBIRD_MUTE_USER` Tool to mute a user in a group channel. Use when you need to prevent a user from sending messages for a specified duration. ### Register Operators by Custom Channel Type **Slug:** `SENDBIRD_REGISTER_OPERATORS_CUSTOM_CHANNEL_TYPE` Registers one or more users as operators for all channels with a specified custom channel type. Use this tool when you need to grant operator privileges to users across all channels that share the same custom_type. Operators have elevated permissions including: - Muting and banning users from channels - Deleting messages in channels - Freezing/unfreezing channels - Managing channel settings Prerequisites: - The user IDs must belong to existing Sendbird users - The custom_type should match channels you want to manage Note: This affects all channels with the specified custom_type, not just a single channel. ### Register Group Channel Operators **Slug:** `SENDBIRD_REGISTER_OPERATORS_GROUP_CHANNEL` Tool to register one or more users as operators in a Sendbird group channel. Use when elevating permissions of existing channel members. ### Register Operators to Open Channel **Slug:** `SENDBIRD_REGISTER_OPERATORS_OPEN_CHANNEL` Tool to register operators to an open channel. Use after creating or updating an open channel when you need to assign operator roles. ### Revoke All Session Tokens **Slug:** `SENDBIRD_REVOKE_ALL_SESSION_TOKENS` Tool to revoke all session tokens for a user. Use when you need to invalidate all active sessions for security. ### Send Message **Slug:** `SENDBIRD_SEND_MESSAGE` Tool to send a message to a group channel. Use when you need to post a text, file, or admin message to an existing group channel. ### Unban User from Group Channel **Slug:** `SENDBIRD_UNBAN_USER` Tool to unban a user from a group channel. Use when reinstating a previously banned user. Execute after confirming the user is currently banned. ### Unmute User **Slug:** `SENDBIRD_UNMUTE_USER` Tool to unmute a user in a group channel. Use when you want to restore a muted user's ability to send messages after confirming they are muted. ### Unregister Operators Custom Channel Type **Slug:** `SENDBIRD_UNREGISTER_OPERATORS_CUSTOM_CHANNEL_TYPE` Tool to unregister operators from channels by custom channel type. Use when you need to remove operator roles from users across channels of a specific custom type. ### Update Count Preference Of Channel **Slug:** `SENDBIRD_UPDATE_COUNT_PREFERENCE_OF_CHANNEL` Tool to update a user's unread count preference for a specific group channel. Use when you want to include or suppress a channel in the user's unread counts. ### Update Group Channel **Slug:** `SENDBIRD_UPDATE_GROUP_CHANNEL` Tool to update group channel information. Use when you need to modify channel attributes such as name, cover image, privacy settings, or operator list after channel creation. ### Sendbird Update Message **Slug:** `SENDBIRD_UPDATE_MESSAGE` Tool to update an existing group channel message in Sendbird. Use after you need to modify content or metadata of a sent message. ### Update Sendbird User **Slug:** `SENDBIRD_UPDATE_USER` Tool to update a user's information. Use when modifying nickname, profile image URL, activation status, or metadata. ### Sendbird View Group Channel **Slug:** `SENDBIRD_VIEW_GROUP_CHANNEL` Tool to view information about a specific group channel. Use when you need channel details after confirming the channel_url. ### Sendbird View Message **Slug:** `SENDBIRD_VIEW_MESSAGE` Tool to view a specific message in a group channel. Use after confirming channel_url and message_id. ### View User **Slug:** `SENDBIRD_VIEW_USER` Tool to retrieve information about a specific Sendbird user. Use when you need to fetch detailed user data by their user ID.