Teamly API
  1. Websockets
  2. WebSocket event envelope
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
    • 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
    • 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
  • Schemas
    • Message
    • Message Embed
    • Channel
    • Direct Message
    • To-do Item
    • Application
    • Emoji
    • Team
    • User
    • Role
    • Webhook
    • Blog
    • Category
  • 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
    • Connecting via WebSocket
  1. Websockets
  2. WebSocket event envelope

Keepalive

When you connect, the heartbeatIntervalMs value is passed along with a READY type response that we send to you. During this period, you must continuously send a request;
{
    "t": "HEARTBEAT",
    "d": {}
}
Modified at 2024-12-28 16:16:42
Previous
WebSocket event envelope
Next
Welcome Message
Built with