SUMMARY.md 44.2 KB
Newer Older
1 2
# Table of contents

3
* [Welcome to Rocket.Chat Docs](README.md)
4
* [Installing and Updating](installation/README.md)
5
  * [Official Recommendations](installation/official-recommendations.md)
6
  * [Hardware Requirements](installation/hardware-requirements.md)
Sing Li's avatar
Sing Li committed
7 8
  * [Snaps](installation/snaps/README.md)
    * [Auto SSL with Snaps](installation/snaps/autossl.md)
9
  * [PaaS Deployments](installation/paas-deployments/README.md)
Gabriel Engel's avatar
sorting  
Gabriel Engel committed
10
    * [Aliyun](installation/paas-deployments/aliyun.md)
11
    * [AWS Marketplace](installation/paas-deployments/eks.md)
Gabriel Engel's avatar
sorting  
Gabriel Engel committed
12 13 14
    * [AWS](installation/paas-deployments/aws.md)
    * [Cloudron.io](installation/paas-deployments/cloudron-io.md)
    * [D2C.io](installation/paas-deployments/d2c-io.md)
15
    * [DigitalOcean](installation/paas-deployments/digitalocean.md)
16
    * [Galaxy](installation/paas-deployments/galaxy.md)
Gabriel Engel's avatar
sorting  
Gabriel Engel committed
17 18 19
    * [Google Cloud Platform](installation/paas-deployments/google-computer-engine.md)
    * [Google Compute Engine](installation/paas-deployments/google-compute-engine.md)
    * [Heroku](installation/paas-deployments/heroku.md)
20
    * [IBM Cloud](installation/paas-deployments/ibm-cloud.md)
Gabriel Engel's avatar
sorting  
Gabriel Engel committed
21 22 23 24
    * [IndieHosters](installation/paas-deployments/indiehosters.md)
    * [Jelastic](installation/paas-deployments/jelastic.md)
    * [Koozali SME](installation/paas-deployments/koozali.md)
    * [OpenShift](installation/paas-deployments/openshift.md)
25
    * [Oracle Cloud](installation/paas-deployments/oracle.md)
Gabriel Engel's avatar
sorting  
Gabriel Engel committed
26 27 28 29 30
    * [ReadySpace](installation/paas-deployments/readyspace.md)
    * [Sandstorm.io](installation/paas-deployments/sandstorm-io.md)
    * [Scalingo](installation/paas-deployments/scalingo.md)
    * [Sloppy.io](installation/paas-deployments/sloppy-io.md)
    * [Syncloud](installation/paas-deployments/syncloud-org.md)
31 32 33 34 35 36 37 38 39 40 41
  * [Automation Tools](installation/automation-tools/README.md)
    * [Ansible](installation/automation-tools/ansible.md)
    * [Kubernetes using Helm](installation/automation-tools/helm-chart.md)
    * [OpenShift](installation/automation-tools/openshift.md)
    * [Vagrant](installation/automation-tools/vagrant.md)
  * [Manual Installation](installation/manual-installation/README.md)
    * [RocketChatCTL](installation/manual-installation/rocketchatctl.md)
    * [Updating](installation/manual-installation/updating/README.md)
      * [Updating from 0.x.x to 0.40.0](installation/manual-installation/updating/from-0-x-x-to-0-40-0.md)
      * [Updating to 1.0](installation/manual-installation/updating/to-1-0.md)
    * [Rocket.Chat on Debian](installation/manual-installation/debian.md)
42
    * [Kali Linux](installation/manual-installation/kali-linux.md)
43 44 45
    * [Migrating database from Meteor built in MongoDB](installation/manual-installation/migrating-meteor-mongo.md)
    * [Running in a sub folder with Apache](installation/manual-installation/running-in-a-sub-folder.md)
    * [Passing extra options to the Mongo driver](installation/manual-installation/mongo-options.md)
Sing Li's avatar
Sing Li committed
46
    * [Rocket.Chat in Ubuntu](installation/manual-installation/ubuntu.md)
47 48 49 50 51 52 53 54 55
    * [Firewall configuration](installation/manual-installation/optional-configurations.md)
    * [Univention Corporate Server \(UCS\)](installation/manual-installation/univention-corporate-server-ucs.md)
    * [Installing Rocket.Chat on Redhat](installation/manual-installation/redhat.md)
    * [Rocket.Chat in CentOS](installation/manual-installation/centos.md)
    * [Running Multiple Instances Per Host To Improve Performance](installation/manual-installation/multiple-instances-to-improve-performance.md)
    * [Setting up Process Managers and Init Systems](installation/manual-installation/pm2-systemd-upstart.md)
    * [Configuring SSL Reverse Proxy](installation/manual-installation/configuring-ssl-reverse-proxy.md)
    * [Configure a replica set for MongoDB](installation/manual-installation/mongo-replicas.md)
    * [Supported Mongo Versions](installation/manual-installation/mongo-versions.md)
56 57
  * [Docker Containers](installation/docker-containers/README.md)
    * [Available Images](installation/docker-containers/available-images.md)
58
    * [systemd](installation/docker-containers/systemd.md)
59
    * [Docker Compose](installation/docker-containers/docker-compose.md)
60 61 62 63
    * [High Availability](installation/docker-containers/high-availability-install.md)
  * [Nonofficial Methods](installation/community-supported-installation/README.md)
    * [OpenSUSE Leap 42.2](installation/community-supported-installation/opensuse.md)
    * [FreeBSD](installation/community-supported-installation/freebsd/README.md)
64
      * [Deploying Rocket.Chat Server Binaries on a FreeBSD system](installation/community-supported-installation/freebsd/universal.md)
65 66
    * [Windows 10](installation/community-supported-installation/windows-10-pro.md)
    * [Windows Server](installation/community-supported-installation/windows-server.md)
67
  * [Mobile and Desktop Apps](installation/mobile-and-desktop-apps.md)
68
  * [Microservices Setup \[beta\]](installation/micro-services-setup-beta.md)
69 70
* [Getting Support](getting-support/README.md)
  * [Untitled](getting-support/untitled.md)
71

72 73 74
## Guides

* [User Guides](guides/user-guides/README.md)
75
  * [Channel Actions](guides/user-guides/channel-actions.md)
Gabriel Engel's avatar
sorting  
Gabriel Engel committed
76
  * [Channels](guides/user-guides/channels.md)
77
  * [Connect to a server](guides/user-guides/connecting-to-a-server.md)
78
  * [Multi-users Direct Message](guides/user-guides/direct-messages-between-multiple-users.md)
Gabriel Engel's avatar
sorting  
Gabriel Engel committed
79
  * [End to End Encryption](guides/user-guides/end-to-end-encryption.md)
80 81
  * [User Panel](guides/user-guides/user-panel/README.md)
    * [My Account](guides/user-guides/user-panel/managing-your-account.md)
Gabriel Engel's avatar
sorting  
Gabriel Engel committed
82 83
  * [Logging into a server](guides/user-guides/login.md)
  * [Message Actions](guides/user-guides/message-actions.md)
84 85
  * [Messages](guides/user-guides/messaging.md)
  * [Registering an account](guides/user-guides/registration.md)
Gabriel Engel's avatar
sorting  
Gabriel Engel committed
86
  * [Talking to users from another server](guides/user-guides/talking-to-users-from-another-server.md)
87 88
  * [Voice and Video Conferencing](guides/user-guides/voice-and-video-conferencing.md)
* [Administrator Guides](guides/administrator-guides/README.md)
89
  * [General](guides/administrator-guides/general.md)
90
  * [CDN](guides/administrator-guides/cdn.md)
Sing Li's avatar
Sing Li committed
91
  * [White-Labeling \(Server and Web App\)](guides/administrator-guides/white-labeling/README.md)
92 93
    * [Advanced White-Labeling](guides/administrator-guides/white-labeling/advanced-white-labeling.md)
    * [Basic White-labeling](guides/administrator-guides/white-labeling/basic-white-labeling.md)
94
  * [Connectivity Services](guides/administrator-guides/connectivity-services.md)
95
  * [Omnichannel](guides/administrator-guides/omnichannel/README.md)
96
    * [Business Hours](guides/administrator-guides/omnichannel/multiple-business-hours.md)
97 98 99 100
    * [Priority queue](guides/administrator-guides/omnichannel/priority-queue.md)
    * [Omnichannel Queue Types](guides/administrator-guides/omnichannel/livechat-queues.md)
    * [Integrating Livechat with Facebook Messenger](guides/administrator-guides/omnichannel/omnichannel-integration.md)
    * [WhatsApp Integration / Twilio](guides/administrator-guides/omnichannel/whatsapp-twilio.md)
101
    * [Canned responses](guides/administrator-guides/omnichannel/canned-responses.md)
102
  * [Authentication](guides/administrator-guides/authentication/README.md)
Sing Li's avatar
Sing Li committed
103
    * [OAuth](guides/administrator-guides/authentication/oauth/README.md)
Sing Li's avatar
Sing Li committed
104
      * [WordPress OAuth Setup](guides/administrator-guides/authentication/oauth/wordpress.md)
Sing Li's avatar
Sing Li committed
105
    * [OpenID Connect](guides/administrator-guides/authentication/open-id-connect/README.md)
Sing Li's avatar
Sing Li committed
106 107 108
      * [Gluu Server 4.0](guides/administrator-guides/authentication/open-id-connect/gluu-server-4.0.md)
      * [Keycloak](guides/administrator-guides/authentication/open-id-connect/keycloak.md)
      * [Okta Identity Cloud Service](guides/administrator-guides/authentication/open-id-connect/okta.md)
109 110
    * [LDAP](guides/administrator-guides/authentication/ldap.md)
    * [SAML](guides/administrator-guides/authentication/saml/README.md)
Sing Li's avatar
Sing Li committed
111 112
      * [Rocket.Chat server settings](guides/administrator-guides/authentication/saml/rocket.chat-server-settings.md)
      * [Simple SAML php](guides/administrator-guides/authentication/saml/simple-saml-php.md)
113 114 115
      * [Active Directory Federation Services](guides/administrator-guides/authentication/saml/active-directory-federation-services.md)
      * [Oracle Identity Cloud Service](guides/administrator-guides/authentication/saml/oracle-cloud.md)
    * [CAS](guides/administrator-guides/authentication/cas.md)
Sing Li's avatar
Sing Li committed
116
    * [iframe based Single Sign On](guides/administrator-guides/authentication/single-sign-on-iframe.md)
117 118
  * [Google Cloud Features](guides/administrator-guides/google-cloud/README.md)
    * [Google Auto Translate](guides/administrator-guides/google-cloud/auto-translate.md)
119
  * [Integrations WebHooks](guides/administrator-guides/integrations/README.md)
Gabriel Engel's avatar
sorting  
Gabriel Engel committed
120 121 122
    * [Add Jira notifications via WebHook](guides/administrator-guides/integrations/jira.md)
    * [AppVeyor](guides/administrator-guides/integrations/appveyor.md)
    * [Azure Alerts](guides/administrator-guides/integrations/azure-alerts.md)
123 124 125
    * [BitRocket](guides/administrator-guides/integrations/bitbucket.md)
    * [Dead Simple Screen Sharing](guides/administrator-guides/integrations/deadsimplescreensharing.md)
    * [EasyRedmine](guides/administrator-guides/integrations/easyredmine.md)
Gabriel Engel's avatar
sorting  
Gabriel Engel committed
126 127
    * [Giphy Integrations](guides/administrator-guides/integrations/giphy.md)
    * [GitHub](guides/administrator-guides/integrations/github.md)
128
    * [GitLab](guides/administrator-guides/integrations/gitlab.md)
Gabriel Engel's avatar
sorting  
Gabriel Engel committed
129 130
    * [Google Calendar](guides/administrator-guides/integrations/google-calendar.md)
    * [Graylog](guides/administrator-guides/integrations/graylog.md)
131
    * [Guggy](guides/administrator-guides/integrations/guggy.md)
Gabriel Engel's avatar
sorting  
Gabriel Engel committed
132 133 134 135 136 137 138 139 140
    * [Jenkins notifications via Rocket.Chat API](guides/administrator-guides/integrations/jenkins.md)
    * [JFrog Xray](guides/administrator-guides/integrations/jfrog-xray.md)
    * [MicroBadger](guides/administrator-guides/integrations/microbadger.md)
    * [Microsoft Teams](guides/administrator-guides/integrations/microsoft-teams.md)
    * [NewRelic](guides/administrator-guides/integrations/newrelic.md)
    * [Nextcloud and WebDAV integrations](guides/administrator-guides/integrations/nextcloud-and-webdav.md)
    * [Nixstats notification](guides/administrator-guides/integrations/nixstats.md)
    * [PagerDuty](guides/administrator-guides/integrations/pagerduty.md)
    * [Prometheus](guides/administrator-guides/integrations/prometheus.md)
141
    * [Review Board](guides/administrator-guides/integrations/reviewboard.md)
Gabriel Engel's avatar
sorting  
Gabriel Engel committed
142
    * [RunDeck Job Notifications](guides/administrator-guides/integrations/rundeck.md)
143
    * [Sentry](guides/administrator-guides/integrations/sentry.md)
Gabriel Engel's avatar
sorting  
Gabriel Engel committed
144 145 146 147 148 149
    * [Simple Telegram Bot:](guides/administrator-guides/integrations/telegram.md)
    * [TravisCI](guides/administrator-guides/integrations/travis-ci.md)
    * [Trello](guides/administrator-guides/integrations/trello.md)
    * [Uptime Robot](guides/administrator-guides/integrations/uptime-robot.md)
    * [Zapier](guides/administrator-guides/integrations/zapier/README.md)
      * [Connect Rocket.Chat to hundreds of other apps with Zapier](guides/administrator-guides/integrations/zapier/using-zaps.md)
150 151
  * [File Upload](guides/administrator-guides/file-upload/README.md)
    * [Amazon S3](guides/administrator-guides/file-upload/amazon-s3.md)
152 153 154
    * [Google Cloud Storage](guides/administrator-guides/file-upload/google-cloud-storage.md)
    * [Minio](guides/administrator-guides/file-upload/minio.md)
    * [WebDAV](guides/administrator-guides/file-upload/webdav.md)
155
  * [Import](guides/administrator-guides/import/README.md)
156
    * [HipChat](guides/administrator-guides/import/hipchat/README.md)
157 158
      * [HipChat Cloud](guides/administrator-guides/import/hipchat/cloud.md)
      * [HipChat Server / Data Center](guides/administrator-guides/import/hipchat/enterprise.md)
159
    * [Slack](guides/administrator-guides/import/slack/README.md)
160
      * [SlackBridge](guides/administrator-guides/import/slack/slackbridge.md)
161
    * [CSV](guides/administrator-guides/import/csv.md)
162
  * [Client Compatibility Matrix](guides/administrator-guides/client-compatibility-matrix.md)
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
  * [Federation](guides/administrator-guides/federation.md)
  * [Account Settings](guides/administrator-guides/account-settings.md)
  * [Plug-ins](guides/administrator-guides/plug-ins/README.md)
    * [Drupal Plug-in](guides/administrator-guides/plug-ins/drupal.md)
    * [Pidgin Plug-in](guides/administrator-guides/plug-ins/pidgin.md)
  * [Managing Settings Using Environment Variables](guides/administrator-guides/settings-via-env-vars.md)
  * [Custom Fields](guides/administrator-guides/custom-fields.md)
  * [Create the first administrator](guides/administrator-guides/create-the-first-admin.md)
  * [Troubleshooting](guides/administrator-guides/troubleshooting.md)
  * [Custom Emoji](guides/administrator-guides/custom-emoji.md)
  * [Email](guides/administrator-guides/email/README.md)
    * [Edit your Email Content](guides/administrator-guides/email/editing-emails-content.md)
    * [Mailer](guides/administrator-guides/email/mailer.md)
    * [Direct Email reply](guides/administrator-guides/email/direct-reply.md)
    * [Email Configuration](guides/administrator-guides/email/setup.md)
  * [Youtube Broadcasting](guides/administrator-guides/youtube-broadcasting.md)
  * [Message Auditing Panel](guides/administrator-guides/message-auditing.md)
  * [Video Conferencing](guides/administrator-guides/setting-up-video-conferencing.md)
  * [Custom sounds](guides/administrator-guides/custom-sounds.md)
  * [Restoring an Admin User](guides/administrator-guides/restoring-an-admin.md)
  * [Permissions](guides/administrator-guides/permissions.md)
  * [Notifications](guides/administrator-guides/notifications/README.md)
    * [Push Notifications](guides/administrator-guides/notifications/push-notifications.md)
  * [Database Migration](guides/administrator-guides/database-migration.md)
  * [Retention Policies](guides/administrator-guides/retention-policies.md)
188
* [Security and Compliance Guides](guides/security/README.md)
189
  * [Security fixes and updates](guides/security/security-updates.md)
190
  * [Compliance Resources](guides/security/compliance-resources.md)
191
* [Developer Guides](guides/developer/README.md)
Sing Li's avatar
Sing Li committed
192 193
  * [Quick Start on Linux](guides/developer/quick-start.md)
  * [Developing on Windows 10](guides/developer/developing-on-windows-10.md)
194 195 196 197 198
  * [Development Workflow](guides/developer/branches-and-releases.md)
  * [Code Styleguide](guides/developer/code-styleguide/README.md)
    * [CSS Styleguide](guides/developer/code-styleguide/less.md)
  * [Internationalization](guides/developer/internationalization.md)
  * [Mobile apps](guides/developer/mobile-apps/README.md)
Sing Li's avatar
Sing Li committed
199
    * [Whitelabeling mobile apps](guides/developer/mobile-apps/whitelabeling-mobile-apps.md)
200 201 202 203 204 205 206 207 208 209 210
    * [Supporting SSL for development on Rocket.Chat](guides/developer/mobile-apps/supporting-ssl.md)
    * [Analytics & Data Usage](guides/developer/mobile-apps/analytics.md)
  * [UI and Theming](guides/developer/ui-and-theming/README.md)
    * [UI Components](guides/developer/ui-and-theming/components.md)
    * [Custom Themes](guides/developer/ui-and-theming/themes.md)
    * [UI Colors](guides/developer/ui-and-theming/colors.md)
  * [Deeplink](guides/developer/deeplink.md)
  * [Testing](guides/developer/testing.md)
  * [Deprecation](guides/developer/deprecation.md)
  * [Embedded Layout](guides/developer/embedded-layout.md)
  * [Iframe Integration](guides/developer/iframe-integration/README.md)
211 212
    * [What is iframe auth?](guides/developer/iframe-integration/authentication/README.md)
      * [Testing the iFrame Authentication](guides/developer/iframe-integration/authentication/testing-the-iframe-authentication.md)
213 214 215 216
    * [Iframe Events](guides/developer/iframe-integration/events.md)
    * [Iframe integration: Sending commands](guides/developer/iframe-integration/commands.md)
  * [Two Factor Authentication](guides/developer/two-factor.md)
  * [Troubleshooting](guides/developer/troubleshooting.md)
217
* [Bots Guides](guides/bots/README.md)
218
  * [Bot Glossary](guides/bots/bot-glossary.md)
219 220 221 222 223 224 225 226 227 228 229 230
  * [Create and run a Bot](guides/bots/create-and-run-a-bot/README.md)
    * [Run a Hubot bot](guides/bots/create-and-run-a-bot/hubot-bot.md)
    * [Run a Botkit Bot](guides/bots/create-and-run-a-bot/botkit-bot.md)
    * [Run a Rocket.Chat SDK Bot](guides/bots/create-and-run-a-bot/rocketchat-sdk-bot.md)
    * [Run a Botpress Bot](guides/bots/create-and-run-a-bot/botpress-bot.md)
    * [Run a Rasa Bot](guides/bots/create-and-run-a-bot/rasa-bot.md)
  * [Running a bBot Bot](guides/bots/running-a-bbot-bot.md)
  * [Configure bot environments](guides/bots/configure-bot-environment.md)
  * [Bots Architecture](guides/bots/bots-architecture.md)
  * [Create a Bot User](guides/bots/create-bot-users.md)
  * [Running a Rasa Bot](guides/bots/running-a-rasa-bot.md)
  * [Running a Hubot bot](guides/bots/running-a-hubot-bot.md)
231
* [Apps Guides](guides/rocket-chat-apps/README.md)
232
  * [Poll](guides/rocket-chat-apps/poll.md)
233
  * [Atlassian](guides/rocket-chat-apps/atlassian/README.md)
234
    * [Jira Server v2.0](guides/rocket-chat-apps/atlassian/jira-server-v2.0.md)
235
    * [Bamboo](guides/rocket-chat-apps/atlassian/bamboo-integration.md)
236 237 238 239
    * [Bitbucket Server](guides/rocket-chat-apps/atlassian/bitbucket-server-integration.md)
    * [Confluence Server](guides/rocket-chat-apps/atlassian/confluence-server-integration.md)
    * [Jira Server](guides/rocket-chat-apps/atlassian/jira-server-integration.md)
  * [Zoom](guides/rocket-chat-apps/zoom.md)
240

241 242
## API

243
* [Schema Definition](api/schema-definition/README.md)
244
  * [User](api/schema-definition/user.md)
245
  * [Room](api/schema-definition/the-room-object.md)
246
  * [Subscriptions](api/schema-definition/subscriptions.md)
247
  * [Message](api/schema-definition/the-message-object.md)
248
* [Schema Definition v2 \(Draft\)](api/schema-definition-v2/README.md)
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
  * [Events](api/schema-definition-v2/events/README.md)
    * [EventContext](api/schema-definition-v2/events/eventcontext.md)
    * [IEvent](api/schema-definition-v2/events/event/README.md)
      * [EventContext](api/schema-definition-v2/events/event/event-context.md)
      * [EventTypeDescriptor](api/schema-definition-v2/events/event/event-type-descriptor.md)
      * [EventMessageTypeDescriptor](api/schema-definition-v2/events/event/eventmessagetypedescriptor.md)
      * [EventDataDefinition](api/schema-definition-v2/events/event/event-data-definition/README.md)
        * [IEventDataEmpty](api/schema-definition-v2/events/event/event-data-definition/i-event-data-empty.md)
        * [IEventDataUpdate](api/schema-definition-v2/events/event/event-data-definition/i-event-data-update.md)
    * [IRoomEvent](api/schema-definition-v2/events/iroomevent/README.md)
      * [RoomEventTypeDescriptor](api/schema-definition-v2/events/iroomevent/roomeventtypedescriptor.md)
      * [RoomEventDataDefinition](api/schema-definition-v2/events/iroomevent/room-event-data-definition/README.md)
        * [IRoomEventDataRoom](api/schema-definition-v2/events/iroomevent/room-event-data-definition/i-room-event-data-room.md)
        * [IRoomEventDataMessage](api/schema-definition-v2/events/iroomevent/room-event-data-definition/i-room-event-data-message.md)
  * [IFederationInfo](api/schema-definition-v2/ifederationinfo.md)
  * [IMessage](api/schema-definition-v2/imessage.md)
  * [IRoom](api/schema-definition-v2/room.md)
  * [IUser](api/schema-definition-v2/user.md)
267 268 269 270 271 272 273 274
* [Realtime API](api/realtime-api/README.md)
  * [Method Calls](api/realtime-api/method-calls/README.md)
    * [Archive Rooms](api/realtime-api/method-calls/archive-rooms.md)
    * [Create Channels](api/realtime-api/method-calls/create-channels.md)
    * [Create Direct Message](api/realtime-api/method-calls/create-direct-message.md)
    * [Create Private Groups](api/realtime-api/method-calls/create-private-groups.md)
    * [Delete Message](api/realtime-api/method-calls/delete-message.md)
    * [Delete Rooms](api/realtime-api/method-calls/delete-rooms.md)
275 276
    * [End-to-End Encryption](api/realtime-api/method-calls/e2e/README.md)
      * [Fetch My Keys](api/realtime-api/method-calls/e2e/e2e.fetch-my-keys.md)
277
      * [Get Users of Room Without Key](api/realtime-api/method-calls/e2e/e2e.get-users-of-room-without-key.md)
278 279
      * [Set Room Key ID](api/realtime-api/method-calls/e2e/e2e.set-room-key-id.md)
      * [Set User Public and Private Keys](api/realtime-api/method-calls/e2e/e2e.set-user-public-and-pivate-keys.md)
280
      * [Update Group Key](api/realtime-api/method-calls/e2e/e2e.update-group-key.md)
281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
    * [Favoriting Rooms](api/realtime-api/method-calls/favoriting-rooms.md)
    * [Get Permissions](api/realtime-api/method-calls/get-permissions.md)
    * [Get Public Settings](api/realtime-api/method-calls/get-public-settings.md)
    * [Get Room Roles](api/realtime-api/method-calls/get-room-roles.md)
    * [Get Rooms](api/realtime-api/method-calls/get-rooms.md)
    * [Get Subscriptions](api/realtime-api/method-calls/get-subscriptions.md)
    * [Get User Roles](api/realtime-api/method-calls/get-user-roles.md)
    * [Hiding Rooms](api/realtime-api/method-calls/hiding-rooms.md)
    * [Joining Channels](api/realtime-api/method-calls/joining-channels.md)
    * [Leaving Rooms](api/realtime-api/method-calls/leaving-rooms.md)
    * [List Custom Emoji](api/realtime-api/method-calls/list-custom-emoji.md)
    * [Load History](api/realtime-api/method-calls/load-history.md)
    * [Login](api/realtime-api/method-calls/login.md)
    * [Logout](api/realtime-api/method-calls/logout.md)
    * [Notify Room Stream](api/realtime-api/method-calls/notify-room-stream.md)
    * [Opening Rooms](api/realtime-api/method-calls/opening-rooms.md)
    * [Pin Message](api/realtime-api/method-calls/pin-message.md)
    * [Register User](api/realtime-api/method-calls/register-user.md)
    * [Save Room Settings](api/realtime-api/method-calls/save-room-settings.md)
    * [Send Message](api/realtime-api/method-calls/send-message.md)
    * [Set Reaction](api/realtime-api/method-calls/set-reaction.md)
    * [Spotlight \(search\)](api/realtime-api/method-calls/spotlight-search.md)
    * [Star Message](api/realtime-api/method-calls/star-message.md)
    * [Unarchive Rooms](api/realtime-api/method-calls/unarchive-rooms.md)
    * [Unpin Message](api/realtime-api/method-calls/unpin-message.md)
    * [Update Message](api/realtime-api/method-calls/update-message.md)
    * [User Presence](api/realtime-api/method-calls/user-presence.md)
  * [Two Factor Authentication](api/realtime-api/2fa.md)
  * [Livechat Realtime API](api/realtime-api/livechat-api/README.md)
310 311 312 313 314
    * [livechat:getInitialData](api/realtime-api/livechat-api/getinitialdata.md)
    * [livechat:registerGuest](api/realtime-api/livechat-api/registerguest.md)
    * [livechat:sendOfflineMessage](api/realtime-api/livechat-api/sendofflinemessage.md)
    * [sendMessageLivechat](api/realtime-api/livechat-api/sendmessagelivechat.md)
    * [stream-livechat-room](api/realtime-api/livechat-api/streamlivechatroom.md)
315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484
  * [Subscriptions](api/realtime-api/subscriptions/README.md)
    * [stream-notify-all](api/realtime-api/subscriptions/stream-notify-all.md)
    * [stream-notify-logged](api/realtime-api/subscriptions/stream-notify-logged.md)
    * [stream-notify-room-users](api/realtime-api/subscriptions/stream-notify-room-users.md)
    * [stream-notify-room](api/realtime-api/subscriptions/stream-notify-room.md)
    * [stream-notify-user](api/realtime-api/subscriptions/stream-notify-user.md)
    * [stream-room-messages](api/realtime-api/subscriptions/stream-room-messages.md)
* [REST API](api/rest-api/README.md)
  * [Avatars](api/rest-api/avatars.md)
  * [Methods](api/rest-api/methods/README.md)
    * [Assets](api/rest-api/methods/assets/README.md)
      * [Set Asset](api/rest-api/methods/assets/setasset.md)
      * [Unset Asset](api/rest-api/methods/assets/unsetasset.md)
    * [Authentication](api/rest-api/methods/authentication/README.md)
      * [Login with Facebook](api/rest-api/methods/authentication/facebook.md)
      * [Logout](api/rest-api/methods/authentication/logout.md)
      * [Login](api/rest-api/methods/authentication/login.md)
      * [Login with Twitter](api/rest-api/methods/authentication/twitter.md)
      * [Me](api/rest-api/methods/authentication/me.md)
      * [Login with Google](api/rest-api/methods/authentication/google.md)
    * [Auto Translate](api/rest-api/methods/autotranslate/README.md)
      * [Get Supported Languages](api/rest-api/methods/autotranslate/getsupportedlanguages.md)
      * [Save Settings](api/rest-api/methods/autotranslate/savesettings.md)
      * [Translate Message](api/rest-api/methods/autotranslate/translatemessage.md)
    * [Commands](api/rest-api/methods/commands/README.md)
      * [Get](api/rest-api/methods/commands/get.md)
      * [List](api/rest-api/methods/commands/list.md)
      * [Preview](api/rest-api/methods/commands/preview.md)
      * [Run](api/rest-api/methods/commands/run.md)
    * [Channels](api/rest-api/methods/channels/README.md)
      * [Channel Add All](api/rest-api/methods/channels/addall.md)
      * [Channel Add Leader](api/rest-api/methods/channels/addleader.md)
      * [Channel Add Moderator](api/rest-api/methods/channels/addmoderator.md)
      * [Channel Add Owner](api/rest-api/methods/channels/addowner.md)
      * [Channel Anonymous Read](api/rest-api/methods/channels/anonymousread.md)
      * [Channel Archive](api/rest-api/methods/channels/archive.md)
      * [Channel Close](api/rest-api/methods/channels/close.md)
      * [Channel Counters](api/rest-api/methods/channels/counters.md)
      * [Channel Create](api/rest-api/methods/channels/create.md)
      * [Channel Delete](api/rest-api/methods/channels/delete.md)
      * [Channel Files](api/rest-api/methods/channels/files.md)
      * [Channel History](api/rest-api/methods/channels/history.md)
      * [Channel Info](api/rest-api/methods/channels/info.md)
      * [Channel Invite](api/rest-api/methods/channels/invite.md)
      * [Channel Join](api/rest-api/methods/channels/join.md)
      * [Channel Kick](api/rest-api/methods/channels/kick.md)
      * [Channel Leave](api/rest-api/methods/channels/leave.md)
      * [Channel List Joined](api/rest-api/methods/channels/list-joined.md)
      * [Channel List](api/rest-api/methods/channels/list.md)
      * [Channel Members List](api/rest-api/methods/channels/members.md)
      * [Channel messages](api/rest-api/methods/channels/messages.md)
      * [Channel Moderators List](api/rest-api/methods/channels/moderators.md)
      * [Channel Online](api/rest-api/methods/channels/online.md)
      * [Channel Open](api/rest-api/methods/channels/open.md)
      * [Channel Remove Leader](api/rest-api/methods/channels/removeleader.md)
      * [Channel Remove Moderator](api/rest-api/methods/channels/removemoderator.md)
      * [Channel Remove Owner](api/rest-api/methods/channels/removeowner.md)
      * [Channel Rename](api/rest-api/methods/channels/rename.md)
      * [Channel Roles](api/rest-api/methods/channels/roles.md)
      * [Channel Set Announcement](api/rest-api/methods/channels/setannouncement.md)
      * [Channel Set Custom Fields](api/rest-api/methods/channels/setcustomfields.md)
      * [Channel Set Default](api/rest-api/methods/channels/setdefault.md)
      * [Channel Set Description](api/rest-api/methods/channels/setdescription.md)
      * [Channel Set Join Code](api/rest-api/methods/channels/setjoincode.md)
      * [Channel Set Purpose](api/rest-api/methods/channels/setpurpose.md)
      * [Channel Set Read Only](api/rest-api/methods/channels/setreadonly.md)
      * [Channel Set Topic](api/rest-api/methods/channels/settopic.md)
      * [Channel Set Type](api/rest-api/methods/channels/settype.md)
      * [Channel Unarchive](api/rest-api/methods/channels/unarchive.md)
      * [Get all the mentions of a channel](api/rest-api/methods/channels/getallusermentionsbychannel.md)
      * [Get Integrations](api/rest-api/methods/channels/getintegrations.md)
    * [Chat](api/rest-api/methods/chat/README.md)
      * [Delete](api/rest-api/methods/chat/delete.md)
      * [React](api/rest-api/methods/chat/react.md)
      * [Update](api/rest-api/methods/chat/update.md)
      * [Report Message](api/rest-api/methods/chat/reportmessage.md)
      * [Follows Message](api/rest-api/methods/chat/followmessage.md)
      * [Get Message](api/rest-api/methods/chat/getmessage.md)
      * [Get Channel Threads](api/rest-api/methods/chat/getthreadslist.md)
      * [Get Deleted Messages](api/rest-api/methods/chat/getdeletedmessages.md)
      * [Get Discussions of A Room](api/rest-api/methods/chat/getdiscussions.md)
      * [Get Mentioned Messages](api/rest-api/methods/chat/getmentionedmessages.md)
      * [Get Message Read Receipts](api/rest-api/methods/chat/getmessagereadreceipts.md)
      * [Get Pinned Messages](api/rest-api/methods/chat/getpinnedmessages.md)
      * [Get Snippeted Message By Id](api/rest-api/methods/chat/getsnippetedmessagebyid.md)
      * [Get Snippeted Messages](api/rest-api/methods/chat/getsnippetedmessages.md)
      * [Get Starred Messages](api/rest-api/methods/chat/getstarredmessages.md)
      * [Get Thread Messages](api/rest-api/methods/chat/getthreadmessages.md)
      * [Ignore User](api/rest-api/methods/chat/ignoreuser.md)
      * [Pins Message](api/rest-api/methods/chat/pinmessage.md)
      * [Post Message](api/rest-api/methods/chat/postmessage.md)
      * [Search](api/rest-api/methods/chat/search.md)
      * [Send Message](api/rest-api/methods/chat/sendmessage.md)
      * [Star Message](api/rest-api/methods/chat/starmessage.md)
      * [Sync Thread List](api/rest-api/methods/chat/syncthreadslist.md)
      * [Sync Thread Messages](api/rest-api/methods/chat/syncthreadmessages.md)
      * [Unfollow Message](api/rest-api/methods/chat/unfollowmessage.md)
      * [Unpins Message](api/rest-api/methods/chat/unpinmessage.md)
      * [Unstar Message](api/rest-api/methods/chat/unstarmessage.md)
    * [Custom Emoji](api/rest-api/methods/emoji-custom/README.md)
      * [Create](api/rest-api/methods/emoji-custom/create.md)
      * [Delete](api/rest-api/methods/emoji-custom/delete.md)
      * [List](api/rest-api/methods/emoji-custom/list.md)
      * [Update](api/rest-api/methods/emoji-custom/update.md)
    * [Custom Sounds](api/rest-api/methods/custom-sounds/README.md)
      * [Custom Sounds List](api/rest-api/methods/custom-sounds/list.md)
    * [Custom User Status](api/rest-api/methods/custom-user-status/README.md)
      * [Custom User Status List](api/rest-api/methods/custom-user-status/list.md)
    * [Groups](api/rest-api/methods/groups/README.md)
      * [Get Integrations](api/rest-api/methods/groups/getintegrations.md)
      * [Group Add All](api/rest-api/methods/groups/addall.md)
      * [Group Add Leader](api/rest-api/methods/groups/addleader.md)
      * [Group Add Moderator](api/rest-api/methods/groups/addmoderator.md)
      * [Group Add Owner](api/rest-api/methods/groups/addowner.md)
      * [Group Archive](api/rest-api/methods/groups/archive.md)
      * [Group Close](api/rest-api/methods/groups/close.md)
      * [Group Counters](api/rest-api/methods/groups/counters.md)
      * [Group Create](api/rest-api/methods/groups/create.md)
      * [Group Delete](api/rest-api/methods/groups/delete.md)
      * [Group History](api/rest-api/methods/groups/history.md)
      * [Group Info](api/rest-api/methods/groups/info.md)
      * [Group Invite](api/rest-api/methods/groups/invite.md)
      * [Group Kick](api/rest-api/methods/groups/kick.md)
      * [Group Leave](api/rest-api/methods/groups/leave.md)
      * [Group List All](api/rest-api/methods/groups/listall.md)
      * [Group List](api/rest-api/methods/groups/list.md)
      * [Group Members](api/rest-api/methods/groups/members.md)
      * [Group messages](api/rest-api/methods/groups/messages.md)
      * [Group Moderators List](api/rest-api/methods/groups/moderators.md)
      * [Group Open](api/rest-api/methods/groups/open.md)
      * [Group Remove Leader](api/rest-api/methods/groups/removeleader.md)
      * [Group Remove Moderator](api/rest-api/methods/groups/removemoderator.md)
      * [Group Remove Owner](api/rest-api/methods/groups/removeowner.md)
      * [Group Rename](api/rest-api/methods/groups/rename.md)
      * [Group Set Announcement](api/rest-api/methods/groups/setannouncement.md)
      * [Group Set Custom Fields](api/rest-api/methods/groups/setcustomfields.md)
      * [Group Set Description](api/rest-api/methods/groups/setdescription.md)
      * [Group Set Purpose](api/rest-api/methods/groups/setpurpose.md)
      * [Group Set Read Only](api/rest-api/methods/groups/setreadonly.md)
      * [Group Set Topic](api/rest-api/methods/groups/settopic.md)
      * [Group Set Type](api/rest-api/methods/groups/settype.md)
      * [Group Unarchive](api/rest-api/methods/groups/unarchive.md)
      * [Groups Files](api/rest-api/methods/groups/files.md)
      * [Groups Roles](api/rest-api/methods/groups/roles.md)
    * [Invite](api/rest-api/methods/invites/README.md)
      * [Find or Create Invite](api/rest-api/methods/invites/findorcreateinvite.md)
      * [List Invites](api/rest-api/methods/invites/listinvites.md)
      * [Remove Invite](api/rest-api/methods/invites/removeinvite.md)
      * [Use Invite Token](api/rest-api/methods/invites/useinvitetoken.md)
      * [Validate Invite Token](api/rest-api/methods/invites/validateinvitetoken.md)
    * [Integration](api/rest-api/methods/integration/README.md)
      * [Create](api/rest-api/methods/integration/create.md)
      * [Get](api/rest-api/methods/integration/get.md)
      * [History](api/rest-api/methods/integration/history.md)
      * [List](api/rest-api/methods/integration/list.md)
      * [Remove](api/rest-api/methods/integration/remove.md)
    * [IM](api/rest-api/methods/im/README.md)
      * [Close](api/rest-api/methods/im/close.md)
      * [Counters](api/rest-api/methods/im/counters.md)
      * [Create](api/rest-api/methods/im/create.md)
      * [Files](api/rest-api/methods/im/files.md)
      * [History](api/rest-api/methods/im/history.md)
      * [List Everyone](api/rest-api/methods/im/list-everyone.md)
      * [List](api/rest-api/methods/im/list.md)
      * [Members](api/rest-api/methods/im/members.md)
      * [Messages Others](api/rest-api/methods/im/messages-others.md)
      * [Messages](api/rest-api/methods/im/messages.md)
      * [Open](api/rest-api/methods/im/open.md)
      * [Set Topic](api/rest-api/methods/im/settopic.md)
    * [Omnichannel \(Livechat\)](api/rest-api/methods/livechat/README.md)
485 486 487
      * [Average waiting time by department](api/rest-api/methods/livechat/average-waiting-time-by-department.md)
      * [Total of transferred chats by department](api/rest-api/methods/livechat/total-of-transferred-chats-by-department.md)
      * [Agents total service time](api/rest-api/methods/livechat/untitled.md)
488
      * [Agents average service time](api/rest-api/methods/livechat/agents-average-service-time.md)
489
      * [Total abandoned chats by department](api/rest-api/methods/livechat/total-abandoned-chats-by-department.md)
490
      * [Percentage of abandoned chats by department](api/rest-api/methods/livechat/percentage-of-abandoned-chats-by-department.md)
491
      * [Agents available for service time](api/rest-api/methods/livechat/agents-available-for-service-time.md)
492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594
      * [Agent Info](api/rest-api/methods/livechat/agent.md)
      * [Appearance](api/rest-api/methods/livechat/appearance.md)
      * [Config](api/rest-api/methods/livechat/config.md)
      * [Custom Field](api/rest-api/methods/livechat/custom-fields.md)
      * [Department](api/rest-api/methods/livechat/department.md)
      * [Inquiries List](api/rest-api/methods/livechat/inquiries.md)
      * [Integrations Settings](api/rest-api/methods/livechat/integrations-settings.md)
      * [Message](api/rest-api/methods/livechat/message.md)
      * [Office Hours](api/rest-api/methods/livechat/office-hours.md)
      * [Queue](api/rest-api/methods/livechat/queue.md)
      * [Room](api/rest-api/methods/livechat/room.md)
      * [Rooms](api/rest-api/methods/livechat/rooms.md)
      * [SMS Incoming](api/rest-api/methods/livechat/sms-incoming.md)
      * [Transcript](api/rest-api/methods/livechat/transcript.md)
      * [Triggers](api/rest-api/methods/livechat/triggers.md)
      * [Users](api/rest-api/methods/livechat/users.md)
      * [Video Call](api/rest-api/methods/livechat/video-call.md)
      * [Visitors](api/rest-api/methods/livechat/visitor.md)
    * [OAuthApps](api/rest-api/methods/oauthapps/README.md)
      * [Get](api/rest-api/methods/oauthapps/get.md)
      * [List](api/rest-api/methods/oauthapps/list.md)
    * [Miscellaneous](api/rest-api/methods/miscellaneous/README.md)
      * [Directory](api/rest-api/methods/miscellaneous/directory.md)
      * [Info](api/rest-api/methods/miscellaneous/info.md)
      * [Shield SVG](api/rest-api/methods/miscellaneous/shield-svg.md)
      * [Spotlight](api/rest-api/methods/miscellaneous/spotlight.md)
      * [Statistics](api/rest-api/methods/miscellaneous/statistics.md)
      * [Statistics List](api/rest-api/methods/miscellaneous/statistics-list.md)
    * [Permissions](api/rest-api/methods/permissions/README.md)
      * [List All](api/rest-api/methods/permissions/listall.md)
      * [Update](api/rest-api/methods/permissions/update.md)
    * [Push Token](api/rest-api/methods/push/README.md)
      * [Delete](api/rest-api/methods/push/deletepushtoken.md)
      * [Post](api/rest-api/methods/push/push-token.md)
    * [Roles](api/rest-api/methods/roles/README.md)
      * [Role AddUserToRole](api/rest-api/methods/roles/addusertorole.md)
      * [Role Create](api/rest-api/methods/roles/create.md)
      * [Role Get Users In Role](api/rest-api/methods/roles/getusersinrole.md)
      * [Role List](api/rest-api/methods/roles/list.md)
      * [Role Sync](api/rest-api/methods/roles/sync.md)
    * [Rooms](api/rest-api/methods/rooms/README.md)
      * [Save Notification](api/rest-api/methods/rooms/savenotification.md)
      * [Admin Rooms](api/rest-api/methods/rooms/adminrooms.md)
      * [Clean History](api/rest-api/methods/rooms/cleanhistory.md)
      * [Rooms Info](api/rest-api/methods/rooms/info.md)
      * [Get Discussions](api/rest-api/methods/rooms/getdiscussions.md)
      * [Get](api/rest-api/methods/rooms/get.md)
      * [Leave](api/rest-api/methods/rooms/leave.md)
      * [Favorite](api/rest-api/methods/rooms/favorite.md)
      * [Upload](api/rest-api/methods/rooms/upload.md)
      * [Create Discussion](api/rest-api/methods/rooms/creatediscussion.md)
    * [Settings](api/rest-api/methods/settings/README.md)
      * [oAuth](api/rest-api/methods/settings/oauth.md)
      * [Private Settings](api/rest-api/methods/settings/get.md)
      * [Public Settings Get](api/rest-api/methods/settings/public.md)
      * [Service Configurations Get](api/rest-api/methods/settings/service-configuration.md)
      * [Settings Get](api/rest-api/methods/settings/get-by-id.md)
      * [Settings Update](api/rest-api/methods/settings/update.md)
    * [Subscriptions](api/rest-api/methods/subscriptions/README.md)
      * [Get One](api/rest-api/methods/subscriptions/getone.md)
      * [Get](api/rest-api/methods/subscriptions/get.md)
      * [Read](api/rest-api/methods/subscriptions/read.md)
      * [Unread](api/rest-api/methods/subscriptions/unread.md)
    * [Users](api/rest-api/methods/users/README.md)
      * [Create Token](api/rest-api/methods/users/createtoken.md)
      * [Create](api/rest-api/methods/users/create.md)
      * [Delete Own Account](api/rest-api/methods/users/deleteownaccount.md)
      * [Delete](api/rest-api/methods/users/deactivateidle.md)
      * [Delete](api/rest-api/methods/users/delete.md)
      * [Forgot Password](api/rest-api/methods/users/forgotpassword.md)
      * [Generate Personal Access Token](api/rest-api/methods/users/generatepersonalaccesstoken.md)
      * [Get Avatar](api/rest-api/methods/users/getavatar.md)
      * [Get Personal Access Tokens](api/rest-api/methods/users/getpersonalaccesstokens.md)
      * [Get Preferences](api/rest-api/methods/users/get-preferences.md)
      * [Get Presence](api/rest-api/methods/users/getpresence.md)
      * [Get Status](api/rest-api/methods/users/getstatus.md)
      * [Get Username Suggestion](api/rest-api/methods/users/getusernamesuggestion.md)
      * [Info](api/rest-api/methods/users/info.md)
      * [List](api/rest-api/methods/users/list.md)
      * [Regenerate Personal Access Token](api/rest-api/methods/users/regeneratepersonalaccesstoken.md)
      * [Register](api/rest-api/methods/users/register.md)
      * [Register](api/rest-api/methods/users/removeothertokens.md)
      * [Remove Personal Access Token](api/rest-api/methods/users/removepersonalaccesstoken.md)
      * [Request Data Download](api/rest-api/methods/users/requestdatadownload.md)
      * [Reset Avatar](api/rest-api/methods/users/resetavatar.md)
      * [Set Active Status](api/rest-api/methods/users/setactivestatus.md)
      * [Set Avatar](api/rest-api/methods/users/setavatar.md)
      * [Set Preferences](api/rest-api/methods/users/set-preferences.md)
      * [Set Status](api/rest-api/methods/users/setstatus.md)
      * [Update own basic information](api/rest-api/methods/users/updateownbasicinfo.md)
      * [Update](api/rest-api/methods/users/update.md)
      * [Users Presence](api/rest-api/methods/users/presence.md)
    * [Video Conference](api/rest-api/methods/video-conference/README.md)
      * [Update Jitsi Timeout](api/rest-api/methods/video-conference/jitsi-update-timeout.md)
    * [Webdav](api/rest-api/methods/webdav/README.md)
      * [Get My Accounts](api/rest-api/methods/webdav/getmyaccounts.md)
  * [Access Tokens](api/rest-api/personal-access-tokens.md)
  * [Two Factor Authentication](api/rest-api/2fa.md)
  * [Query and Fields](api/rest-api/query-and-fields-info.md)
  * [Pagination](api/rest-api/offset-and-count-and-sort-info.md)
  * [Rate Limiter](api/rest-api/rate-limiter.md)
* [Livechat Widget API](api/livechat-api.md)

595 596 597
## Contributors

* [How can I help?](contributors/contributing/README.md)
598 599 600
  * [Bug Reporting](contributors/contributing/reporting-issues.md)
  * [Developing](contributors/contributing/developing.md)
  * [Documenting](contributors/contributing/documentation/README.md)
601 602
    * [New Feature Template](contributors/contributing/documentation/new-feature-draft.md)
    * [Feature Change Template](contributors/contributing/documentation/feature-change-draft.md)
603 604
    * [Status Map](contributors/contributing/documentation/documentation-map/README.md)
      * [Missing Articles](contributors/contributing/documentation/documentation-map/missing-and-outdated-list.md)
605
    * [Markdown Style Guide](contributors/contributing/documentation/markdown-styleguide.md)
606
  * [Promoting](contributors/contributing/promoting.md)
607 608 609 610 611
  * [Security](contributors/contributing/security/README.md)
    * [Responsible Disclosure Policy](contributors/contributing/security/responsible-disclosure-policy.md)
  * [Translating](contributors/contributing/translating.md)
* [Code of Conduct](contributors/code_of_conduct.md)
* [Google Summer of Code](contributors/gsoc/README.md)
612
  * [Google Summer of Code 2021](contributors/gsoc/google-summer-of-code-2021.md)
613
  * [Google Summer of Code 2020](contributors/gsoc/google-summer-of-code-2020.md)
Sing Li's avatar
Sing Li committed
614 615 616
  * [Google Summer of Code 2019](contributors/gsoc/google-summer-of-code-2019.md)
  * [Google Summer of Code 2018](contributors/gsoc/google-summer-of-code-2018.md)
  * [Google Summer of Code 2017](contributors/gsoc/google-summer-of-code-2017.md)
617 618
* [Google Season of Docs](contributors/google-season-of-docs/README.md)
  * [Google Season of Docs 2019](contributors/google-season-of-docs/google-season-of-docs-2019.md)
619

620 621 622
## Apps Development

* [Getting Started](apps-development/getting-started.md)
623
* [Fundamentals](apps-development/fundamentals/README.md)
624
  * [App Lifecycle](apps-development/fundamentals/app-lifecycle.md)
625
  * [Event Interfaces](apps-development/fundamentals/event-interfaces.md)
626
* [Recipes](apps-development/recipes/README.md)
627
  * [Sub-command pattern](apps-development/recipes/sub-command-pattern.md)
628
  * [Making HTTP Requests](apps-development/recipes/making-http-requests.md)
629
  * [Storing User Input](apps-development/recipes/storing-user-input.md)
630
  * [Registering API endpoints](apps-development/recipes/registering-api-endpoints.md)
631
* [Slack Compatibility](apps-development/slack-compatibility.md)
632 633
* [Apps-Engine API Reference](https://rocketchat.github.io/Rocket.Chat.Apps-engine)

634 635 636 637
## Rocket.Chat SaaS

* [FAQ](rocket.chat-saas/faq.md)

638 639 640
## Legal

* [Terms of Service](legal/terms.md)
641
* [Master Services Agreement for Self Managed Workspaces](legal/master-services-agreement-for-self-managed-workspaces.md)
642
* [Privacy Policy](legal/privacy.md)
643 644 645 646 647
* [Code of Conduct](legal/code-of-conduct.md)
* [GDPR](legal/gdpr.md)
* [Censorship and Harmful Content](legal/censorship-and-harmful-content.md)
* [Guidelines for Law Enforcement](legal/guidelines-for-law-enforcement.md)
* [Server Lookup](legal/server-lookup.md)
648
* [DMCA Policy](legal/dmca-policy.md)
649