Skip to main content

Overview

Getting Started#

Understanding everything you need to know to get to work in Zuri Chat.

What is Zuri Chat?#

Zuri Chat is a very flexible open source messaging app for organizations connecting members to information they need whenever they need them. Zuri Chat brings people together in an inclusive manner easing the unification of teams and transforming communications within organizations.

How Zuri Chat works#

Zuri Chat unlike other messaging apps, offers more functionality via a plugin system where each room can be provided by different providers giving you more control over your workspace and workspace's features.

This documentation will introduce you to all the basic information you need such as the Zuri core API documentation and an overview of what plugins are so you can better understand the services offered by Zuri Chat.

Core API Documentation#

The Zuri Chat Core API documentation provides developers with a concise and self explanatory detail on everything you need to get started working and building with Zuri Chat and the various services that Zuri Chat offers. The documentation gives a detailed explanation on how to make API calls for the authetication of users, user creation, workspace management, plugin installation, configurations and integrations and so much more. Some of the core APIs covered in this documentation include:

  • Authentication
  • Users
  • Data
  • Organizations
  • Marketplace
  • Plugins

What is a plugin?#

A plugin is a standalone app provided by different pre-approved plugin providers which you can choose to add to your workspace to boost productivity. There are several plugins available at the Zuri Chat market place. These plugins can easily be installed and configured to suite your workspace needs. Plugins can also be uninstalled anytime.

Some of the available plugins on Zuri Chat include:

Channels#

Channels are very fundamental to the Zuri Chat app, bringing the right people together in one place organizing work around a specific common goal.

Direct Messages#

Discussions that do not require the attention of the entire team takes place here. DMs can be used for conversations that require the attention of a particular team mate or line supervisor or manager.

Music Plugin#

With Zuri Chat, the music plugin lets you enter into a room and enjoy some good music and also share music with colleagues without disrupting the workflow or having to go outside the app.

Files Plugin#

The files plugin lets you save, share, collaborate and access documents within an organization right inside of Zuri Chat. Files can also be protected so you don't have to worry about having confidential documents fall into the wrong hands.

Goals Plugin#

Do you have have personal goals? Or it's a common goal? Do you need to track your progress and that of your team? Then the goals plugin is here for you. It helps you organize your goals, keep track of your progress and achievements so you never lose focus.

Todo Plugin#

If you have a long list of tasks to carry out as a team or as individuals, keeping track of all the tasks in the list can sometimes be a daunting challenge. Sometimes, you just forget these tasks. We don't want that for you or your team which is why we have brought you the Todo plugin. It helps you to list out your tasks so you never forget or miss out any one of them.

Chess Plugin#

Are you a lover of chess? Did a team mate challenge you to a chess game? Great! The chess plugin lets you enjoy some chess moments right here in Zuri Chat. As a team, you can also organize chess competitions and enjoy some bonding moments without having to leave your workspace. You can choose the multiplayer mode to play with a colleague or decide to explore the game with an automated opponent.

There are many more plugins on the Zuri Chat workspace to make your remote workspace experience a fabulous one. Don't hesitate to explore.

How Do I get started with a plugin#

You can visit the Zuri Chat market place to add a plugin to your organization's workspace and configure the plugin to suite your needs and help improve productivity. When a plugin is added to the workspace, it automatically appears on the side bar but Zuri Chat gives you the liberty to organize the plugins on the sidebar to help improve your productivity. You can also decide to remove a plugin from the sidebar.

For more enquries, please reach out us @ E-mail: developer@zuri.chat

API Endpoint#

BASE URL:

https://api.zuri.chat/

Dive in#

Create an account with zurichat:

https://zuri.chat/signup