SUMMARY.md

Table of contents

• Rocket.Chat Developer

Getting Started

• Deploy Rocket.Chat
• Development Environment Setup
• Architecture and Components
• Deep linking
• Two Factor Authentication

Contribute to Rocket.Chat

• Code of Conduct
• Code Review Process
• Modes of Contribution
  • Participate in Rocket.Chat Development
    • Development Workflow
    • Code Style Guide
    • Pull Request's Tags
    • Languages
    • Internationalization
    • Troubleshooting
  • Assist with Testing Rocket.Chat
  • Contribute Through Bug Reporting
  • Documentation Contribution Guidelines
    • Markdown Style Guide
    • Documentation Template
  • Security Contribution Guidelines
    • Responsible Disclosure Policy
  • Translation Contribution Guidelines
  • Promote Rocket.Chat
  • Contribute to Rocket.Chat FAQs

Customize and Embed

• Embedded Layout
• White Labeling
  • Customizing Colors
• Iframe Integration
  • Configuring iFrame auth
    • Testing the iFrame Authentication
  • Adding a Rocket.Chat chat room to your web app
  • Iframe Events
  • Iframe integration: Sending commands

Open-Source Projects

• Server
  • Repository Structure
  • Server Environment Setup
    • Gitpod
    • Linux
    • Mac OSX
    • Windows 10
  • Server Architecture
  • Server Customization
    • UI Components
    • Custom Themes
    • UI Colors
  • Deploying Rocket.Chat server
• Desktop App
  • Developing your Desktop App
  • Debugging your Desktop App
  • Desktop App White Labeling
    • Desktop Changing Default Settings
• Mobile App
  • Supporting SSL for development on Rocket.Chat
  • Analytics & Data Usage
  • Testing your Mobile App
  • Mobile App White Labeling
    • iOS App White Labeling
    • Android App White Labeling
  • Configuring Push Notifications
  • Mobile App FAQs

Chat Engine

• Overview of Chat Engine
• Chat Engine in iframe
• Chat Engine with Custom Frontend

Apps-Engine

• Rocket.Chat Apps-Engine
• Getting Started with Apps-Engine
  • Apps-Engine CLI
• Create an App
• Extend App Capabilities
  • Slash Commands
    • Slash Command Examples
  • HTTP Requests
  • Event Interfaces and Handlers
    • Email - Event Interfaces
    • Livechat - Event Interfaces
    • Message - Event Interfaces
    • Room - Event Interfaces
    • Settings - Event Interfaces
    • Uploads - Event Interfaces
    • Users - Event Interfaces
    • Event Interface Examples
  • Apps-Engine User Interface
    • Contextual Bar
    • Building Blocks
    • Action Buttons
    • Apps-Engine UI Guidelines
• App Configuration
• App Internationalization
• App Data Persistence
  • Managing Internal State
  • Storing User Input
• App Permission System
• App Development Lifecycle
• Video Conferencing Apps
• Omnichannel Apps
• Advanced Features
  • OAuth2 Client
  • Scheduler API
  • Register API Endpoints
  • NPM Package Support (Experimental)
• App Submission to the Marketplace
  • Content Guidelines
  • Graphics Guidelines
  • Publisher Webhooks
• Apps-Engine Reference
  • Contribute to Apps-Engine
  • Apps-Engine API Reference

Omnichannel

• Omnichannel Environment Setup
• Livechat widget development and customization
• Developing Omnichannel Bots
  • Dialogflow
  • Rasa
• Omnichannel FAQs
• Developing Omnichannel Apps
  • Channel Apps
  • Chatbots
  • CRM Apps

Bots

• Bots Development Environment Setup
• Bots Architecture
• Creating Your Own Bot From Scratch
  • Develop a Rocket.Chat SDK Bot
  • Develop a Botpress Bot
• Bots FAQs

Reference

• API
  • REST API
    • Endpoints
      • Authentication
        • Login
        • Login with Facebook
        • Login with Twitter
        • Login with Google
        • Logout
        • My Profile
        • REST Two Factor Authentication
      • User Management
        • Avatars
        • Users Endpoints
          • Create User
          • Delete User
          • Delete Own Account
          • Get Avatar
          • Set User's Status Active
          • Deactivate Idle Users
          • Get User's Presence
          • Get User's Info
          • Get Users List
          • Register User
          • Reset Avatar
          • Set Avatar
          • Get Status
          • Set Status
          • Update User
          • Update Own Basic Information
          • Create Users Token
          • Get User Preferences
          • Set Preferences
          • Forgot Password
          • Get Username Suggestion
          • Generate Personal Access Token
          • Regenerate Personal Access Token
          • Get Personal Access Tokens
          • Remove Personal Access Token
          • Enable 2fa Email
          • Disable 2fa Email
          • Send 2fa code
          • Users Presence
          • Request Data Download
          • Logout Other Clients
          • Autocomplete User
          • Remove Other Tokens
          • Reset Users E2E Key
          • Reset Users TOTP
          • List users teams
          • Report User
          • Logout User Endpoint
        • LDAP Endpoints
          • LDAP SyncNow
        • Permissions Endpoints
          • List all permissions
          • Update permissions
        • Roles Endpoints
          • Role AddUserToRole
          • Role Create
          • Role Update
          • Role Get Users In Role
          • Role List
          • Role Sync
          • Role Delete
          • Role Remove
      • Rooms
        • Groups Endpoints
          • Group Online
          • Get Integrations
          • Group Add All
          • Group Add Leader
          • Group Add Moderator
          • Group Add Owner
          • Group Archive
          • Group Close
          • Group Counters
          • Group Create
          • Group Delete
          • Group History
          • Group Info
          • Group Invite
          • Group Kick
          • Group Leave
          • Group List All
          • Group List
          • Group Members
          • Group Messages
          • Group Moderators List
          • Group Open
          • Group Remove Leader
          • Group Remove Moderator
          • Group Remove Owner
          • Group Rename
          • Group Set Announcement
          • Group Set Custom Fields
          • Group Set Description
          • Group Set Purpose
          • Group Set Read Only
          • Group Set Topic
          • Group Set Type
          • Group Unarchive
          • Groups Files
          • Group Set Encrypted
          • Group convertToTeam
          • Groups Roles
        • Channels Endpoints
          • Channel Add All
          • Channel Add Leader
          • Channel Add Moderator
          • Channel Add Owner
          • Channel Anonymous Read
          • Channel Archive
          • Channel Close
          • Channel Counters
          • Channel Create
          • Channel Delete
          • Channel Files
          • Channel History
          • Channel Info
          • Channel Invite
          • Channel Join
          • Channel Kick
          • Channel Leave
          • Channel List Joined
          • Channel List
          • Channel Members List
          • Channel Messages
          • Channel Moderators List
          • Channel Online
          • Channel Open
          • Channel Remove Leader
          • Channel Remove Moderator
          • Channel Remove Owner
          • Channel Rename
          • Channel Roles
          • Channel Set Announcement
          • Channel Set Custom Fields
          • Channel Set Default
          • Channel Set Description
          • Channel Set Join Code
          • Channel Set Purpose
          • Channel Set Read Only
          • Channel Set Topic
          • Channel Set Type
          • Channel Unarchive
          • Get all the mentions of a channel
          • Get Integrations of channel
          • Convert channel to team
        • Rooms Endpoints
          • Save Room Notification
          • Admin Rooms
          • Clean Room History
          • Rooms Info
          • Get Discussions
          • Get Rooms
          • Leave Room
          • Delete Room
          • Favorite/Unfavourite a Room
          • Upload File to a Room
          • Room name autocomplete for team
          • Autocomplete private channel
          • Get Admin Rooms
          • Save Room Settings
          • Change Archivation State
          • Export Room
          • Create Discussion
        • Teams Endpoints
          • List of teams of caller
          • List All Teams with Info
          • Create a new Team
          • Convert team to channel
          • Add Rooms to a Team
          • Remove a room from team
          • Update Room from a team
          • List Rooms of a team
          • List Rooms Of User of a team
          • Get Team's Members
          • Add Members to Team
          • Update a Team's Member
          • Remove Member from Team
          • Leave a Team
          • Get Team's Info
          • Delete a Team
          • Autocomplete Team
          • Update a Team
        • Directory
      • Messaging
        • Chat Endpoints
          • Chat Message Delete
          • Chat Message Reactions
          • Message Update
          • Report Message
          • Follow Message
          • Get Message
          • List Threads
          • Get Deleted Messages
          • Get Discussions of A Room
          • Get Mentioned Messages
          • Get Message Read Receipts
          • Get Pinned Messages
          • Get Snippeted Message By Id
          • Get Snippeted Messages
          • Get Starred Messages
          • Get Thread Messages
          • Ignore User
          • Pins Message
          • Post Message
          • Search Message
          • Send message
          • Star Message
          • Sync Thread List
          • Sync Thread Messages
          • Sync Messages
          • Unfollow Message
          • Unpins Message
          • Unstar Message
        • IM Endpoints
          • Close
          • Counters
          • Create
          • Delete
          • Files
          • History
          • List Everyone
          • List
          • Members
          • Messages Others
          • Messages
          • Open
          • Set Topic
      • Omnichannel
        • Livechat Endpoints
          • Livechat Users
            • Register New Agent or Manager
            • Get List of Agents or Managers
            • Get Agent or Manager Information
            • Remove Agent or Manager
          • Livechat Agents
            • Get Agent Information
            • Get Next Agent Information
            • Get Available Agent Information
          • Livechat Contacts
            • Register or Update Omnichannel Contact
            • Get Omnichannel Contact
            • Search Omnichannel Contacts
          • Livechat Messages
            • Send New Livechat Message
            • Send Array of Messages
            • Update Livechat Message
            • Get a Livechat Message
            • Get Livechat Message History
            • Delete Livechat Message
            • Send Livechat Offline Message
          • Livechat Visitors
            • Register Livechat Visitor
            • Get Visitor Information
            • Get Visitor Information by ID
            • Get Open Conversation of a Visitor
            • Search Visitors by Term
            • Get Pages Visited by Livechat Visitor
            • Get Livechat Visitor Chat History
            • Search Visitor Chat
            • Visitor Autocomplete
            • Set Visitor Status
            • Delete Visitor
          • Livechat Statistics
            • Get Agent Analytics Overview
            • Get Analytics Overview
          • Get Livechat Configurations
          • Livechat Rooms
            • Get List of Livechat Rooms
            • Get or Create Livechat Rooms
            • Close Livechat Room
            • Join Livechat Room
            • Update Livechat Room
            • Update Livechat Room Visitor
            • Transfer Livechat Room
            • Forward Livechat Room
            • Survey Livechat Room
            • Put Livechat Room on Hold
            • Set Livechat Room Priority
            • Remove Livechat Room Priority
          • Livechat Custom Field
            • Send a Livechat custom field
            • Send an array of Livechat custom fields
            • List livechat custom fields
            • Get info about a custom field
          • Livechat Audio Video Calls
            • Start Call
            • Update Call Status
          • Livechat Page Visited
            • Send Visitor navigation history
          • Livechat Transcript
            • Request a Livechat Transcript for the Visitor
            • Send Livechat Transcript
            • Delete Livechat Transcript Request
            • Request PDF Transcript
          • Livechat Transfer
          • Livechat Agent Stats
            • Departments for an agent
            • Agents average service time
            • Agents total service time
            • Agents available for service history
          • Livechat Appearance
            • Get Livechat Appearance
            • Set Livechat Appearance
          • Livechat Business Hours
            • Get Business Hours
            • Business Hour Info
            • Business Hours List
          • Livechat Dashboards
            • Conversation Totalizers
            • Agent Productivity Totalizers
            • Chat Totalizers
            • Department Productivity Totalizers
            • Chats Chart
            • Chats per agent chart
            • Agents Statuses Chart
            • Chats per department chart
            • Timings Charts
          • Livechat Department
            • Get a list of departments
            • Register a new department
            • Get info about a department
            • Update a department
            • Remove a department
            • Department autocomplete
            • Retrieve agents of a department
            • Update agents of a department
            • Listing departments by ids
            • Amount of chat
            • Average service time by department
            • Average chat duration time by department
            • Total service time by department
            • Average waiting time by department
            • Total transferred chat by department
            • Total abandoned chats by department
            • Percentage of abandoned chats by department
            • Departments available by unit Id
            • Departments by Unit Id
          • Livechat Inquiries
            • Inquiries List
            • Take Inquiry
            • Inquiries Queued
            • Inquiry Get One
            • Set SLA to Inquiry
            • Inquiry Prioritize
          • Livechat Integrations
          • Livechat Queue
          • Livechat SMS Incoming (Twilio)
          • Livechat Triggers
            • List Livechat Triggers
            • Get a Livechat Trigger
          • Livechat Upload
          • Livechat Monitors
            • Get Monitors
            • Get a Monitor
            • List of Monitors
            • Get one Monitor
          • Livechat Priorities
            • Get Priorities
            • Get a Priority
            • Update Priority
            • Reset Priorities
            • Priorities (Older versions)
              • Get Priorities
              • Get a Priority
              • List of Priorities
              • Get one Priority
          • Livechat Tags
            • Get Tags
            • Get a Tag
            • List of Tags
            • Get one Tag
          • Livechat Units
            • Get Units
            • Get a Unit
            • Create Unit
            • Update Unit
            • Delete Unit
            • Get List of Unit Monitors
            • Get Available Departments by Unit Id
            • Get Department by Unit Id
            • List of Unit
            • Get one Unit
            • List of unit monitors
          • Reports
            • Get Conversations by Status
            • Get Conversation by Departments
            • Get Conversations by Tags
            • Get Conversation by Agents
          • SLA Policies
            • Get SLA Policies
            • Create SLA Policy
            • Get an SLA
            • Update an SLA
            • Delete an SLA
        • Voice Channel Endpoints
          • Voice channel registration information
          • Voice channel query summary
          • Voice channel queue membership
            • Get Call Center Queue Membership Information
            • Get Call Center Queue Membership Subscription Information
          • Voice channel server connection
            • Check Call Server Connection
            • Check Management Server Connection
          • Voice channel events
            • Send Call Center Events
          • Voice channel room
            • Get Call Center Rooms
            • Create Call Center Room
            • Get Call Center Room
            • Close Call Center Room
          • Create voice channel visitor
          • Voice channel extension(s)
            • Get call center Extensions
            • Get Call Center Extension
          • Agent extension(s)
            • Get Omnichannel Agent Extension
            • Update Omnichannel Agent Extension
            • Delete Omnichannel Agent Extension
        • Canned Responses
          • Create a Canned Response
          • Update a Canned Response
          • List All Canned Responses
          • Get User Canned Responses
          • Remove Canned Response
          • Get a Canned Response
      • Integrations
        • Integration Endpoints
          • Create Integration
          • Get Integration
          • List Integration History
          • List Server's Integrations
          • Update an Integration
          • Remove an Integration from Server
        • Webdav Endpoint
          • Get My Accounts
        • OAuthApps Endpoints
          • Get
          • List
      • Notifications
        • Banners Endpoints
          • Get banner by id
          • Get banners
          • Dismiss a banner
        • Push Token Endpoints
          • Get push notification
          • Delete push token
          • Post push token
      • Content Management
        • Assets Endpoints
          • Set Asset
          • Unset Asset
        • Custom Emoji Endpoints
          • List all custom emojis
          • Create new custom emoji
          • Delete custom emoji
          • Get Updated list of custom emojis
          • Update a custom emoji
        • Custom Sounds Endpoints
          • Custom Sounds List
        • Custom User Status Endpoints
          • Custom User Status List
          • Create custom user status
          • Delete custom user status
          • Update custom user status type
      • Statistics
        • Statistics list
        • Stats Endpoints
          • Get statistics
          • Get statistics list
        • Engagement Dashboard
          • Users Engagement Dashboard
            • List New Users
            • List Active Users
            • List User By Time of the Day
            • Get Hourly Data When Chat is Busier
            • Get Weekly Data When Chat is Busier
          • Messages Engagement Dashboard
            • Get Messages Sent
            • Get Origin of Message Sent
            • Get the Most Popular Channels
          • Channels Engagement Dashboard
            • Get Channels
        • Subscriptions Endpoints
          • Get all subscriptions
          • Get subscription room
          • Mark channel as read
          • Mark messages as unread
      • Settings
        • Settings Endpoints
          • Get public settings
          • Get all oAuth
          • Get private settings
          • Add Custom OAuth
          • Update setting
          • Get setting by id
          • Get Service configurations
        • Cloud Endpoints
          • Cloud Manual Register
        • DNS Endpoints
          • DNS Resolve txt
          • DNS Resolve srv
        • E2E Endpoints
          • Fetch your E2E Keys
          • Get Users Of Room Without E2E Key
          • Set Room E2E key
          • Set Users Key
          • Update User E2E Key in Room
        • Import Endpoints
          • Upload Import File
          • Download Public Import File
          • Start Import
          • Get Import File Data
          • Get Import Progress
          • Get Latest Import Operations
          • Download Pending Files
          • Download Pending Avatars
          • Get Current Import Operations
        • Bulk User Import Endpoints
          • New
          • Add Users
          • Run
          • Status
          • Clear
        • Instances Endpoints
          • Get instances
        • Federation Endpoints
          • Add federated server
          • List servers
          • Remove federated server
          • Search public rooms
          • Join external public room
        • Moderation Endpoints
          • Get Reported Messages
          • Get a User's Reported Messages
          • Fetch Reports of a Message
          • Fetch Info of a Report
          • Dismiss Reports
          • Delete Reported Messages of a User
        • Device Management Endpoints
          • Get Current User Sessions
          • List All Sessions
          • Get Current User Session Information
          • Get Session Information
          • Logout Current User Session
          • Logout Session
      • Marketplace Apps
        • Rasa App
          • Close Chat
          • Perform Handover
      • Miscellaneous
        • Auto Translate Endpoints
          • Get Supported Languages
          • Save Settings
          • Translate Message
        • Email Inbox Endpoints
          • Email inbox list
          • Set email inbox
          • Email inbox by id
          • Delete email inbox by id
          • Search email inbox
          • Send test email to email inbox
        • Shield SVG
        • Spotlight
        • Get stdout queue
        • Licenses
          • Get Licenses
          • Add License
          • Confirm Enterprise License
          • Get Maximum Active User
        • WhatsApp Endpoints
          • WhatsApp omnichannel integration API
          • Template Whatsapp message
        • Video Conference Endpoints
          • Update Jitsi Timeout
        • Commands Endpoints
          • Get slash Commands
          • List slash commands
          • Get command's preview data
          • Execute command's preview item
          • Execute a slash command
        • Install Private Apps
        • Mailer Endpoint
          • Send Mailer Endpoint
          • Mailer Unsubscribe Endpoint
        • Invite Endpoints
          • Find or Create Invite
          • List Invites
          • Delete invite by id
          • Remove Invite
          • Report use Invite Token
          • Validate Invite Token
  • Realtime API
    • Method Calls
      • Authentication
        • Register User
        • Login
        • Realtime Two Factor Authentication
      • Rooms
        • Get Rooms
        • Get Room By Id
        • Get Room Name By Id
        • Archive Rooms
        • Unarchive Rooms
        • Favorite/Unfavourite a Room
        • Hiding Rooms
        • Opening Rooms
        • Leaving Rooms
        • Delete Rooms
        • Create Direct Message
        • Create Private Group
        • Notify Room Stream
        • Load History
        • Add Room Leader
        • Add Room Moderator
        • Add Room Owner
        • Mute User In a Room
        • Unmute User In a Room
        • Add a User to a Room
        • Check If Room Name Exists
        • Save Room Settings
        • Get Room Roles
      • Channels
        • Create Channels
        • Create Private Groups
        • Joining Channels
      • Messages
        • Send Message
        • Get Single Message
        • Delete Message
        • Star/Unstar Message
        • Set/Unset Reactions
        • Pin Message
        • Unpin Message
        • Update Message
      • Users
        • Set User Presence
        • Set User Password
        • Get User Roles
        • List Custom Emoji
      • End-to-End Encryption API
        • Fetch My Keys
        • Get Users of Room Without Key
        • Set Room Key ID
        • Set User Public and Private Keys
        • Update Group Key
      • OAuth Service
        • Add OAuth Service
        • Remove OAuth Service
        • Refresh OAuth Service
      • Get Permissions
      • Get Public Settings
      • Check Username Availability
      • Restart Server
      • Get Subscriptions
      • Spotlight (search)
    • Livechat Realtime API
      • livechat:registerGuest
      • livechat:sendOfflineMessage
      • stream-livechat-room
      • sendMessageLivechat
    • Subscriptions
      • stream-notify-all
      • stream-notify-logged
      • stream-notify-room-users
      • stream-notify-room
      • stream-room-messages
      • stream-notify-user
  • Deprecated Endpoints
  • Schema Definition
    • User
    • Room
    • Message
    • Subscriptions
  • Livechat Widget API

Fuselage Design System

• Monorepo
• Conventions
• Componentization
• Accessibility
• Color Palette
• Testing
  • Fuselage's component in RC
• Third party libraries
• Contributing