Learn, build, and get the most out of TeamChat
Guides and reference material to help your team hit the ground running.
Guides & Best Practices
Getting Started Guide
Set up your workspace, create channels, invite your team, and send your first message in under 5 minutes.
- 1.Sign in and create your first organization
- 2.Set up channels for your team (e.g. #general, #engineering, #design)
- 3.Share your invite link with teammates
- 4.Set your focus status and send your first message
Focus Mode Best Practices
Learn how to set up focus hours, configure notification policies, and help your team protect their deep work time.
- 1.Set your status to Focused during deep work blocks
- 2.Only Urgent messages will notify you in Focus mode
- 3.Encourage your team to tag messages with the right priority
- 4.Use Away status when you're offline to set expectations
Team Onboarding Playbook
A step-by-step guide for rolling out TeamChat to your team, including channel structure and communication norms.
- 1.Create an organization and define your channel structure
- 2.Write a channel description for each channel explaining its purpose
- 3.Share invite links with your team members
- 4.Pin a welcome message with your team's communication guidelines
Video Huddles & Screen Sharing
Master instant video calls, screen sharing with collaborative drawing, and when to huddle vs. message.
- 1.Click the huddle button in any channel to start a call
- 2.Toggle your camera and microphone as needed
- 3.Share your screen and use the drawing overlay to annotate
- 4.Huddles are best for quick syncs -- keep async for everything else
Message Priority Framework
Define what counts as Urgent, Normal, and FYI for your team. Reduce noise and improve response times.
- 1.Urgent: Needs response within the hour, breaks through Focus mode
- 2.Normal: Standard messages, respond when you're available
- 3.FYI: No response expected, just keeping the team informed
- 4.Agree on these definitions as a team and revisit quarterly
Quick Polls Handbook
When to use polls vs. threads, crafting clear poll options, and making group decisions asynchronously.
- 1.Use polls for decisions with clear options (dates, names, choices)
- 2.Keep options to 2-4 for faster consensus
- 3.Set a deadline in your message so people know when to vote by
- 4.Close the poll and share the outcome in a follow-up message
Developer Reference
Technical details for building on top of TeamChat.
REST API
Create messages, manage channels, and build custom workflows with the TeamChat REST API.
All endpoints follow RESTful conventions. Authentication is handled via session cookies. JSON request and response bodies.
WebSocket Events
Subscribe to real-time messages, reactions, typing indicators, and presence updates.
Connect to the WebSocket server for instant updates. Events include new_message, reaction_added, typing, and user_presence.
Organization Management
Programmatically create organizations, manage members, and configure channels.
Invite users via shareable codes, set roles, and manage channel permissions through the API.