Weavy concepts
With Weavy you can quickly add contextual collaboration features to any application in a fast and efficient way. Read below to learn more about some important concepts.
Your application
Your application is where you integrate Weavy. The way your application is structured, and the technology used, will direct where and how Weavy should be integrated.
Environment
An environment is a web application that handles Weavy backend/server logic and data storage. The environment exposes a Web API and handles realtime communication through websockets and event notification via webhooks.
App
Weavy provides a number of apps with collaboration features that you can add to your application. Some examples are chat, feeds, files etc.
UIKit
We offer UIKits for several different frameworks. The UIKits integrate with your application and renders a fully functional user interface for Weavy apps and their functionality.
Context
Your application probably has several different areas and sections where you want to add collaboration features. In Weavy we call them contexts and identify them by a uid
which is a string that uniquely identifies your context
(note that the uid
cannot contain whitespace and must contain at least one non-digit).
User
In order to integrate Weavy your application must have some sort of user system in place. Weavy will not provide a user system for you, instead we leverage the existing user system that you already have.
To identify a user in your application Weavy needs you to supply a uid
. The uid
is a string that uniquely identifies your user, typically your internal user id
(note that the uid
cannot contain whitespace and must contain at least one non-digit,
for instance, if a user has the integer id 256
in your system you can create an uid
by adding a one letter prefix, e.g. u256
).
User directory
You can separate users in different organizations with user directories. This is useful in multi-tenant scenarios where you want multiple organizations to use the same Weavy environment. Optionally, it also enables communication across organizations, something which is not possible with multiple environments.