Sendbird is a platform that provides chat, voice, and video APIs to help businesses build in-app communication features.
Sendbird is a platform that provides chat, voice, and video APIs to help businesses build in-app communication features. On Nagent, Sendbird is exposed as a fully-configurable communication integration that any agent can call — 37 actions, and API key authentication. No code is required to wire Sendbird into your workflow — connect it once via the External Integrations panel and reuse it across every agent you build.
Agent builders use Sendbird to automate the kinds of tasks communication teams previously handled manually. Concrete examples — each one is a single agent step in Nagent — include:
Every action and trigger is paired with a structured input/output schema (visible in the sections below), so when you wire Sendbird into Helix — our agentic agent builder — the editor knows exactly what each step expects and produces. Configure once, deploy anywhere across your Nagent agents.
Every operation an agent can call against Sendbird, with input parameters and output schema. Drop these into any step of an agent built in Helix.
SENDBIRD_ADD_MEMBERS_GROUP_CHANNELTool to add members to a group channel. Use when you need to invite one or more users into an existing group channel.
Input parameters
Duration in seconds to hide previous messages. Required if hide_existing_messages is true.
List of User IDs to add to the channel.
URL-encoded identifier of the target group channel.
Whether to hide previous messages for new members.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SENDBIRD_BAN_USER_FROM_GROUP_CHANNELTool 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.
Input parameters
Duration of the ban in seconds. If omitted, ban is permanent.
ID of the user to ban from the channel.
ID of the admin or moderator performing the ban.
URL-encoded identifier of the group channel to ban the user from.
Reason for the ban in moderation records.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SENDBIRD_CREATE_CHANNELTool to create a new group channel. Use when you need to start a conversation with specific users. Execute after specifying users and optional settings.
Input parameters
Custom data for the channel
Name of the channel
True for strict creation; fails if channel exists
True to create a supergroup channel
List of user IDs to invite to the channel (max 100)
URL of the channel cover image
True to create a public channel
Binary content of the cover image for multipart upload
Access code for private channels
Custom URL of the channel; autogenerated if omitted
Custom type identifier for the channel
True to create a distinct channel
True to create an ephemeral channel
List of user IDs to assign as operators
Custom fields object
True to list the channel in search results
True to send system notifications for channel events
Message retention period in seconds
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SENDBIRD_CREATE_USERCreates 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.
Input parameters
Unique identifier for the new user. Must be unique across the application. Can contain alphanumeric characters, underscores, and hyphens.
Custom key-value pairs to store additional user data. Keys and values must be strings.
Display name shown to other users in channels. If not provided, may default to user_id.
If true, the user is active and can send/receive messages. Inactive users cannot participate in channels.
URL of the user's profile image. Must be a valid HTTP/HTTPS URL.
User's phone number in E.164 format (e.g., +15551234567). Used for user discovery if enabled.
Binary content of the user's profile image for multipart upload. Use this instead of profile_url when uploading an image file directly.
List of unique keys used to find this user through the discovery feature (e.g., email addresses, phone numbers).
Internal flag indicating if the user has ever logged in. Typically managed by the system.
If true, generates and returns an access token for the user that can be used for client-side authentication.
List of ISO 639-1 language codes indicating user's preferred languages for push notifications.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SENDBIRD_DELETE_CHANNELPermanently 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.
Input parameters
The unique URL identifier of the group channel to delete. This is the channel's unique ID, typically in format like 'sendbird_group_channel_123456' or a custom URL set during channel creation.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SENDBIRD_DELETE_MESSAGEPermanently 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.
Input parameters
Unique numeric ID of the message to delete. Must be a positive integer obtained from message listing or message sending responses.
URL-encoded identifier of the group channel containing the message to delete. Can be obtained from channel creation responses or channel listing endpoints.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SENDBIRD_DELETE_USERTool to delete a Sendbird user. Use when you need to remove a user from your Sendbird application, optionally permanently.
Input parameters
Unique ID of the user to delete.
Whether to permanently delete the user and all associated data.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SENDBIRD_GET_COUNT_PREFERENCE_OF_CHANNELTool 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.
Input parameters
The unique ID of the user.
URL (identifier) of the group channel.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SENDBIRD_GET_NUMBER_OF_CHANNELS_BY_JOIN_STATUSRetrieves 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.
Input parameters
The unique ID of the target user whose group channel count will be retrieved.
Filter by channel type. 'super' channels support up to tens of thousands of members; 'nonsuper' regular channels support up to 100 members. Defaults to 'all'.
Filter by channel visibility. 'public' channels allow users to join without invitation; 'private' channels require an invitation. Defaults to 'all'.
Filter by custom channel types. Only channels matching one of the specified custom types will be counted. Pass an empty list or omit to include all custom types.
Filter by channel distinctness. 'distinct' channels resume conversations with the same members; 'nondistinct' allows multiple channels with identical member sets. Defaults to 'all'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SENDBIRD_GET_NUMBER_OF_UNREAD_ITEMSTool 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.
Input parameters
Unique ID of the user whose unread item counts are to be retrieved.
Comma-separated list of item keys to retrieve. Options: non_super_group_channel_unread_message_count, super_group_channel_unread_message_count, group_channel_unread_message_count, non_super_group_channel_unread_mention_count, super_group_channel_unread_mention_count, group_channel_unread_mention_count, non_super_group_channel_invitation_count, super_group_channel_invitation_count, group_channel_invitation_count. If not specified, returns all available counts.
Comma-separated list of custom channel types to filter the count by.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SENDBIRD_ISSUE_SESSION_TOKENIssues 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.
Input parameters
The unique ID of the user to issue a session token for.
Optional token expiration timestamp in Unix milliseconds. If omitted, the default token lifetime is used.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SENDBIRD_LEAVE_GROUP_CHANNELSTool to leave group channels for a user. Use when you need to make a user exit one or more joined group channels.
Input parameters
Unique ID of the user who will leave group channels.
Custom type to filter which group channels to leave. Only channels with this custom type will be left.
List of group channel URLs to leave. Required unless `should_leave_all` is true or `custom_type` is specified.
Whether to leave all joined group channels. If true, `channel_urls` is ignored.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SENDBIRD_LIST_BANNED_MEMBERSTool to list banned members in a group channel. Use when you need to see which users are banned from a specific group channel.
Input parameters
Number of banned members to return per page (1-100). Default is 10.
Pagination token from previous response; omit for first request.
Unique URL of the group channel to list banned members from.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SENDBIRD_LIST_GROUP_CHANNEL_MESSAGESTool 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=<last_read>, prev_limit=0, next_limit=<batch_size>, include=false.
Input parameters
Whether to include the anchor message in the results. Default is false.
Whether to reverse the order of results. Default is false.
Filter messages by a single sender's user ID.
Message ID anchor. Use to fetch messages around this message. Required if message_ts is not provided.
Timestamp anchor in Unix milliseconds. Use to fetch messages around this time. Required if message_id is not provided.
Number of messages to retrieve after the anchor (0-200). Default is 10.
Number of messages to retrieve before the anchor (0-200). Default is 0.
Filter messages by multiple sender user IDs (comma-separated).
URL-encoded identifier of the group channel.
Filter by custom message types (comma-separated).
Filter by message type. Options: MESG (text), FILE (file), ADMM (admin). Can combine with commas.
Filter by operator status. Options: all, operator, nonoperator.
Whether to include reaction information. Default is false.
Whether to include removed messages. Default is false.
Filter by reply type. Options: all, only_reply_to_channel, none.
Whether to include thread information. Default is false.
Whether to include poll details for messages with polls. Default is false.
Whether to include sorted metadata arrays. Default is false.
Whether to include parent message information for threaded messages. Default is false.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SENDBIRD_LIST_GROUP_CHANNELSTool to list group channels. Use when you need to fetch paginated group channels with optional filters.
Input parameters
Filter channels by channel name
Number of results per page (1-100)
Pagination token to retrieve the next page
Whether to include empty channels in the results
Filter by super channel type: all, super, or nonsuper
Filter by public channel type: all, public, or private
Whether to include frozen channels in the results
Filter channels by exact URLs
Filter channels by custom types
Filter channels whose URL contains this substring
List channels created after this timestamp (in milliseconds)
Filter by distinct channel type: all, distinct, or nondistinct
Whether to include channel metadata
List channels created before this timestamp (in milliseconds)
Filter by member state: all, joined_only, invited_only, invited_by_friend, or invited_by_non_friend
Filter channels by member nickname
Whether to include read receipt data
List of user IDs who must all be members of the channel
List of user IDs one of whom must be a member of the channel
Whether to include delivery receipt data
Filter channels whose custom type starts with this prefix
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SENDBIRD_LIST_MEMBERS_GROUP_CHANNELTool to list members of a group channel. Use when you need to paginate through members of a specified group channel.
Input parameters
Maximum number of results to return (1-100)
Sorting order of members list
Pagination token for fetching the next page
Number of results to skip before returning the set (deprecated; use token instead)
Unique URL of the group channel
Filter by operator status
Filter by membership state
Filter by muted status of members
Search members whose nicknames start with this string
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SENDBIRD_LIST_OPERATORS_CUSTOM_CHANNEL_TYPETool 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.
Input parameters
Maximum number of operators to return per page (1-100).
Pagination cursor from a previous call; omit for the first request.
Custom channel type to list operators for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SENDBIRD_LIST_OPERATORS_GROUP_CHANNELTool to list operators of a group channel. Use after specifying the channel_url when needing to paginate through operators.
Input parameters
Number of operators to return per page (1-100). Default is 10.
Pagination token from previous response; omit for first page
URL of the group channel to retrieve operators from
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SENDBIRD_LIST_OPERATORS_OPEN_CHANNELTool 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.
Input parameters
Maximum number of operators to return per page (1-100).
Pagination cursor from a previous response; omit for the first request.
URL-encoded unique identifier of the open channel to list operators for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SENDBIRD_LIST_USERSRetrieves 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.
Input parameters
Maximum number of users to return per page (1-100). Defaults to 10 if not specified.
Sort order for results. Options: 'nickname_alphabetical' (A-Z by nickname), 'created_at' (newest first), 'user_id_alphabetical' (A-Z by user ID).
Pagination token from the 'next' field of a previous response. Omit for the first page.
Filter users by exact nickname match (case-insensitive).
Filter to only return specific users by their IDs. Provide as a list of user ID strings.
Filter by account status. Set to true for active users, false for deactivated users.
Filter users by their custom type classification.
Filter users who have this metadata key set. Use with metatag_values for key-value filtering.
Filter users by metadata values for the specified metatag_key. Requires metatag_key to be set.
Filter users whose nickname contains this substring (case-insensitive partial match).
Filter by login history. Set to true for users who have logged in, false for never logged in.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SENDBIRD_MARK_ALL_USER_MESSAGES_AS_READTool 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.
Input parameters
Unique ID of the user whose messages will be marked as read.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SENDBIRD_MUTE_USERTool to mute a user in a group channel. Use when you need to prevent a user from sending messages for a specified duration.
Input parameters
Mute duration in seconds (0 = indefinite)
ID of the user to mute
URL-encoded identifier of the target group channel
Custom description for the mute action
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SENDBIRD_REGISTER_OPERATORS_CUSTOM_CHANNEL_TYPERegisters 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.
Input parameters
The custom channel type identifier. This assigns operator privileges to specified users for all channels that have this custom type. The custom_type must match an existing channel's custom_type value.
List of existing Sendbird user IDs to register as operators. At least one user ID is required. Operators have elevated privileges like muting/banning users, deleting messages, and managing channel settings.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SENDBIRD_REGISTER_OPERATORS_GROUP_CHANNELTool to register one or more users as operators in a Sendbird group channel. Use when elevating permissions of existing channel members.
Input parameters
List of user IDs to register as operators
URL-encoded identifier of the group channel
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SENDBIRD_REGISTER_OPERATORS_OPEN_CHANNELTool to register operators to an open channel. Use after creating or updating an open channel when you need to assign operator roles.
Input parameters
List of user IDs to register as operators (at least one)
URL-encoded identifier of the open channel
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SENDBIRD_REVOKE_ALL_SESSION_TOKENSTool to revoke all session tokens for a user. Use when you need to invalidate all active sessions for security.
Input parameters
Unique ID of the user whose session tokens will be revoked.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SENDBIRD_SEND_MESSAGETool 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.
Input parameters
Free-form custom data string (often JSON)
Text content of the message. Required when message_type is 'MESG'
Attach an existing poll by its ID
Sender's user ID. Required unless using API token as acting user
Send as silent message (no push notifications)
Array of metadata objects
URL-encoded identifier of the target group channel
Custom message type for classification
Mention scope: 'users' to mention specific users or 'channel' to mention all
Type of message: 'MESG' for text, 'FILE' for file, 'ADMM' for admin message
Reply in a thread to the message with this ID
List of user IDs to mention when mention_type is 'users'
Mark as operator (moderator) message
List of language codes for auto-translation, e.g., \['en', 'es'\]
Push notification option: 'default', 'suppress', or 'include_offline_user'
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SENDBIRD_UNBAN_USERTool to unban a user from a group channel. Use when reinstating a previously banned user. Execute after confirming the user is currently banned.
Input parameters
The URL of the group channel from which to unban the user.
The unique ID of the banned user to unban.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SENDBIRD_UNMUTE_USERTool 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.
Input parameters
URL-encoded identifier of the group channel to unmute the user in.
User ID to unmute from the channel.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SENDBIRD_UNREGISTER_OPERATORS_CUSTOM_CHANNEL_TYPETool 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.
Input parameters
List of user IDs to unregister as operators.
Custom channel type to target. Example: 'my_custom_type'
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SENDBIRD_UPDATE_COUNT_PREFERENCE_OF_CHANNELTool 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.
Input parameters
The unique ID of the user.
URL identifier of the group channel.
The user's count preference for the channel: one of 'all', 'unread_message_count_only', 'mention_count_only', or 'none'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SENDBIRD_UPDATE_GROUP_CHANNELTool 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.
Input parameters
Custom channel data as a JSON-encoded string
New name for the channel
Whether this is a supergroup channel
HTTPS URL for the channel's cover image
Whether this channel is publicly joinable
List of user IDs to assign as channel operators
Access code required for joining this channel
URL identifier of the group channel to update
Custom type label for the channel
Whether this is a distinct channel
Whether this channel is ephemeral
Unread count preference ("unread_message_count_only" or "all_count")
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SENDBIRD_UPDATE_MESSAGETool to update an existing group channel message in Sendbird. Use after you need to modify content or metadata of a sent message.
Input parameters
Additional data for the message as a JSON-encoded string
New text content of the message
ID of the user performing the update
Deduplication ID for the message update
Whether the message update should be silent (no push notification)
Unique ID of the message to update
URL identifier of the group channel containing the message
Custom type label for the message
Mention type for the message (e.g., 'users' or 'channel')
Type of the message (e.g., 'MESG' or 'FILE')
APNs bundle ID for iOS push notifications
Sorted metaarray objects for the message
List of user IDs to mention in the message
Push notification delivery option ('default', 'suppress')
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SENDBIRD_UPDATE_USERTool to update a user's information. Use when modifying nickname, profile image URL, activation status, or metadata.
Input parameters
Unique ID of the user to update
Custom key-value store for user metadata
New display name for the user
Set to false to deactivate the user account
URL of the new profile image
Whether to issue a new access token for the user
List of language tags for localization
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SENDBIRD_VIEW_GROUP_CHANNELTool to view information about a specific group channel. Use when you need channel details after confirming the channel_url.
Input parameters
URL-encoded identifier of the group channel to retrieve.
Whether to include the channel's member list in the response.
Whether to include channel metadata in the response.
Whether to include read receipt information in the response.
Whether to include migration information in the response.
Whether to include delivery receipt information in the response.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SENDBIRD_VIEW_MESSAGETool to view a specific message in a group channel. Use after confirming channel_url and message_id.
Input parameters
Unique ID of the message.
URL-encoded identifier of the group channel.
Whether to include sorted_metaarray arrays in the response.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SENDBIRD_VIEW_USERTool to retrieve information about a specific Sendbird user. Use when you need to fetch detailed user data by their user ID.
Input parameters
The unique ID of the user to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
No publicly available marketplace agent is found using this tool yet. There are 75 agents privately built on Nagent that already use Sendbird.
Build on Nagent
Connect Sendbird to any Nagent agent in minutes — no API key management, no boilerplate. Just configure and deploy.
The five questions agent builders ask before adopting a new integration.
Open the External Integrations panel inside Nagent (app.nagent.ai/externalIntegration), find Sendbird, and click "Connect Now." You'll authenticate with an API key — Nagent handles credential storage and refresh automatically. Once connected, Sendbird is available to any agent in your workspace.
No. Nagent provides no-code integration for every tool. Once Sendbird is connected, you configure its 37 actions directly in the agent builder UI — no API calls, no boilerplate, no schema management.
Helix — Nagent's agentic agent builder — lets you drop Sendbird steps into any workflow visually. Pick an action (e.g., one of those listed above), fill in the inputs (Helix knows the required vs. optional schema for each parameter), and connect it to upstream/downstream steps. Triggers run as the entry point of an agent, so when a Sendbird event fires, the agent kicks off automatically.
Every Sendbird action and trigger ships with a fully-typed schema — input parameters with name, type, required flag, and description, plus the output payload shape. The schemas are documented in the sections above. Helix uses these schemas to validate your configuration at build time and to type-check the data flowing between steps.
Yes. While Sendbird ships with 37 pre-built communication actions, you can layer custom logic around them inside Helix — pre/post-processing steps, conditional branches, retries, or stitching Sendbird together with other connected tools. For deeper customization, talk to our team about Nagent's Agentic AI Lab — forward-deployed engineers who build Sendbird-based workflows tailored to your business.