View as Markdown
Sendbird icon

Sendbird ACTION

Send message

Sends a message to a channel. See the docs here
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Sendbird account once, then configure and run Send message from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "sendbird-send-message",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    sendbird: { authProvisionId: "apn_xxxxxxx" },
    applicationId: "Application Id",
    channelType: "Channel Type",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Send message inputs
Property Type Description
applicationId Application Id string
Specifies the unique ID of the Application. To find the application ID, sign in to Sendbird Dashboard, go to Settings > Application > General, and then check Application ID.
Required
channelType Channel Type string
Specifies the type of the channel. Acceptable values are open_channels and group_channels.
Required
channelUrl Channel URL string
Specifies the url of the channel.
Required Dynamic
userId User Id string
Specifies the user ID of the sender.
Required Dynamic
sendPush Send Push boolean
Determines whether to send a push notification for the message to the members of the channel (applicable to group channels only). Unlike text and file messages, a push notification for an admin message is not sent by default. (Default: true)
Optional
mentionType Mention Type string
Specifies the mentioning type which indicates the user scope who will get a notification for the message. Acceptable values are users and channel. If set to users, only the specified users with the mentioned_users property below will get notified. If set to channel, all users in the channel will get notified. (Default: users)
Optional
mentionedUserIds Mentioned User Ids string[]
Specifies an array of one or more IDs of the users who will get a notification for the message.
Optional Dynamic
isSilent Is Silent boolean
Determines whether to send a message without updating some of the channel properties. If a message is sent in a channel, with this property set to true, the channel's last_message is updated only for the sender while its unread_message_count remains unchanged for all channel members.
Optional
dedupId Dedup Id string
Specifies the unique message ID created by other system. In general, this property is used to prevent the same message data from getting inserted when migrating the messages of the other system to Sendbird server. If specified, the server performs a duplicate check using the property value.
Optional
messageType Message Type string
Specifies the type of the message.
Required

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
sendbird-send-message
Version
0.0.2
App
Sendbird
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes