Teamly API
  1. Websocket events
Teamly API
  • Introduction
  • Getting Started
    • Quick Start
    • API Versions
  • Permissions
    • Channel Permission Values
    • Team Global Permissions
  • Core Resources
    • Channels
      • Update Channel
        • Update Team Channel
        • Update Channel Role Permissions
      • Get Team Channels
      • Create Team Channel
      • Delete Team Channel
      • Duplicate a Channel on Team
      • Update Channel Priorities of Team
      • Get Channel By Id
    • Messages
      • Create Channel Message
      • Delete a Channel Message
      • Get Channel Messages
      • Update a Channel Message
      • React to Message
      • Delete Reaction from Message
      • Get a Channel Message by Id
    • Teams
      • Members
        • Add Role to Member
        • Remove Role from Member
        • Kick Member from Team
        • Get Member
      • Bans
        • Get Banned Users
        • Unban User
        • Ban User
      • Get a Team
      • Update a Team
    • Roles
      • Create a Role for Team
      • Get Team Roles
      • Delete a Role
      • Clone Role
      • Update Role Priorities of Team
      • Update a Team Role
    • Users
      • Get User By Id
      • Get Logged In User
    • Todos
      • Get Todo Items
      • Create Todo Item
      • Delete Todo Item
      • Clone Todo Item
      • Update Todo Item
    • Direct Messages
      • Create a Direct Message
    • Applications
      • Get Application Submissions
      • Update a Application Status
      • Update Team's Application Status
      • Update Team's Application Questions
      • Get Application By Id
    • Reactions
      • Get Team's Custom Reactions
      • Create New Custom Reaction for Team
      • Update a Custom Reaction
      • Delete a Custom Reaction
    • Attachments
      • Upload Attachment
    • Voice
      • Get Credentials for Join Voice Channel
      • Update Your Voice Metadata
      • Leave from Voice Channel
      • Move Member
      • Disconnect Member from Voice
    • Webhooks
      • Create Message With Webhook
      • Webhook for GitHub
    • Blog
      • Get Blog Posts
      • Create a Blog Post
      • Delete a Blog Post
    • Category
      • Create a Category
      • Update a Category
      • Update Category Role Permissions
      • Delete a Category
      • Add a Channel To Category
      • Delete a channel from category
      • Set channel priority of category
      • Set a team's category priority
    • Announcements
      • Get Announcements
      • Create Announcement
      • Delete Announcement
  • Schemas
    • Message
    • Message Embed
    • Channel
    • Direct Message
    • To-do Item
    • Application
    • Emoji
    • Team
    • User
    • Role
    • Webhook
    • Blog
    • Category
    • Announcement
  • Websockets
    • Example Bot
    • WebSocket event envelope
      • WebSocket event envelope
      • Keepalive
      • Welcome Message
      • Gateway Opcodes
      • Gateway Close Event Codes
    • Websocket events
      • CHANNEL_CREATED
      • CHANNEL_DELETED
      • CHANNEL_UPDATED
      • MESSAGE_SEND
      • MESSAGE_UPDATED
      • MESSAGE_DELETED
      • MESSAGE_REACTION_ADDED
      • MESSAGE_REACTION_REMOVED
      • PRESENCE_UPDATE
      • TEAM_ROLE_CREATED
      • TEAM_ROLE_DELETED
      • TEAM_ROLES_UPDATED
      • TEAM_UPDATED
      • TODO_ITEM_CREATED
      • TODO_ITEM_DELETED
      • TODO_ITEM_UPDATED
      • USER_JOINED_TEAM
      • USER_LEFT_TEAM
      • USER_JOINED_VOICE_CHANNEL
      • USER_LEFT_VOICE_CHANNEL
      • USER_PROFILE_UPDATED
      • USER_ROLE_ADDED
      • USER_ROLE_REMOVED
      • USER_UPDATED_VOICE_METADATA
      • BLOG_CREATED
      • BLOG_DELETED
      • CATEGORIES_PRIORITY_UPDATED
      • CATEGORY_UPDATED
      • CATEGORY_DELETED
      • CATEGORY_CREATED
      • CHANNELS_PRIORITY_UPDATED
      • ANNOUNCEMENT_CREATED
      • ANNOUNCEMENT_DELETED
      • APPLICATION_CREATED
      • APPLICATION_UPDATED
      • VOICE_CHANNEL_MOVE
    • Connecting via WebSocket
  1. Websocket events

MESSAGE_SEND

KeyDescriptionType
messageMessageMessage
channelIdTriggered Channel IdString
teamIdTriggered Team IdString
channelTypeTriggered Channel TypeString
Message
id
string 
required
Unique identifier for the message
channelId
string 
required
ID of the channel where the message was posted
type
string 
required
Type of the message (e.g., 'text' for a text message)
content
string  | null 
required
Content of the message (Markdown supported)
<= 2000 characters
attachments
array [object {1}]  | null 
optional
Attachments for the message (may be empty)
<= 5 items
url
string 
required
createdBy
object (User) 
required
User who created the message
id
string 
required
Unique identifier for the user
username
string 
required
Username of the user
>= 1 characters<= 20 characters
subdomain
string 
required
Subdomain associated with the user
profilePicture
string <uri>
optional
URL to the user's profile picture
Default:
null
banner
string <uri>
optional
URL to the user's banner image
Default:
null
bot
boolean 
required
Indicates whether the user is a bot
Default:
false
presence
number 
required
Presence status of the user (e.g., online, offline, etc.)
>= 0<= 3
Default:
0
flags
string 
required
badges
array [object {3}] 
required
List of badges awarded to the user
userStatus
object 
optional
Status set by the user
userRPC
object 
optional
Rich presence details of the user
connections
array [object] 
required
List of external connections the user has
createdAt
string <date-time>
required
Timestamp of when the user was created
Default:
CURRENT_TIMESTAMP
lastOnline
string <date-time> | null 
deprecated
Timestamp of when the user was last online
Default:
CURRENT_TIMESTAMP
system
boolean 
required
Indicates whether the user is a system account
Default:
false
editedAt
string <date-time>
optional
Timestamp of when the message was last edited
replyTo
string 
optional
ID of the message being replied to, or null if the message is not a reply
embeds
array[object (Message Embed) {8}] 
required
List of embeds included with the message
<= 5 items
title
string  | null 
required
Title of the embed
<= 16 characters
description
string  | null 
required
Description text for the embed (Markdown supported)
<= 1024 characters
url
string <uri> | null 
optional
URL associated with the embed
color
number  | null 
required
Color code for the embed, represented in hexadecimal format
author
object  | null 
required
Contains information about the author of the embed
thumbnail
object  | null 
required
Contains information about the thumbnail image
image
object  | null 
required
Contains information about the image
footer
object  | null 
required
Contains information about the footer
emojis
array [object {1}] 
optional
emojiId
string 
optional
The emoji used in the message
reactions
array [object {3}] 
optional
emojiId
string 
optional
The emoji used for the reaction
count
number 
optional
Number of users who reacted with this emoji
users
array [object {2}] 
optional
nonce
string 
optional
Unique identifier for this message instance, used to prevent duplicates
createdAt
string <date-time>
required
Timestamp of when the message was created
mentions
object 
required
Information about users mentioned in the message
users
array[string]
optional
List of user IDs mentioned in the message
Modified at 2024-12-28 16:24:45
Previous
CHANNEL_UPDATED
Next
MESSAGE_UPDATED
Built with