TalkJS

TalkJS provides chat APIs and SDKs that enables developers to add fully featured, in-app messaging to web and mobile apps in minutes. Launch fast with pre-built, customizable UIs and powerful SDKs for JavaScript, React, React Native, and Flutter. Built for speed, reliability, and security, TalkJS scales to power real-time chat for marketplaces, communities, and collaborative teams.

Company

• About: Overview of TalkJS's history, team, workplace culture, and mission to offer the best chat API and SDKs for apps and websites.
• Careers: Lists multiple remote engineering roles at TalkJS, and emphasizes a work culture of autonomy, impactful work, and a culture of freedom and trust.
• Partnerships: Invitation for agencies and SaaS providers to build white‑label chat solutions using TalkJS, with partner benefits and examples.
• Contact: A form to request a demo or speak with an expert to discuss chat requirements and pricing.
• Privacy policy: Details on GDPR compliance, data processing practices, and how user information is handled and safeguarded.
• Pricing: Overview of pricing tiers, features per plan, and FAQs.
• Terms of Service: Legal terms defining the license, user responsibilities, service levels, liability limits, data protection, and jurisdiction.

Developer resources

• Developer documentation: Official documentation covering TalkJS SDKs, APIs, components, code samples, and tutorials to get started quickly.
• Tutorials: Step‑by‑step hands‑on guides to integrate chat features in various frameworks such as Next.js, Laravel, as well as add AI chatbots.
• Demos: Interactive showcases allowing you to test TalkJS chat features in real time.
• Changelog: Live feed of product updates, release notes, new features, and bug fixes across SDKs and UI components.
• Status: Real‑time operational health dashboard showing uptime, incidents, and performance metrics for TalkJS services.
• Chat support: Quick access launcher to start a live chat with support.
• Email support: Opens the user's mail client to email TalkJS support directly.

Features

• Features overview: High‑level overview of key TalkJS features such as notifications, themes, and moderation.
• Design Customization: Details on how to fully customize chat UI with themes, colors, fonts, and layouts.
• Notifications: Overview of TalkJS’s notification system including real‑time alerts and badges.
• Pre-built UI: Information on TalkJS’s ready‑to‑use chat components to speed up development.
• On-premise chat: Details about deploying TalkJS in your own infrastructure for full control.
• Email to chat sync: Explains automatic synchronization between email and chat conversations.
• Moderation and analytics: Covers admin tools, content moderation, usage insights, and analytics.

Use cases

• Use cases overview: Overview of different use cases for TalkJS chat functionality.
• Social and communities solutions: Chat solutions tailored for social networks and community platforms.
• Marketplace solutions: Chat workflows for connecting buyers and sellers in marketplaces.
• Hiring platforms: Chat tools designed for recruiting platforms to connect candidates and employers.
• On-demand solutions: Chat support for on‑demand services such as delivery or ride‑sharing apps.
• Group chat: Use case details for small-to-mid sized group conversations.
• Large group chat: Solutions for high‑scale, community‑level group chat scenarios.
• SaaS solutions: Integration of chat into SaaS products to boost engagement and support.
• Healthcare solutions: Chat use cases for healthcare and doctor-patient communication.
• In-app comments: Chat-based commenting systems for articles, docs, or collaborative tools.
• 1-on-1 chat: Private direct messaging between two users.
• Message and notification center: Central hub for organizing chats, notifications, and updates.
• AI chatbots: Solution for integrating AI‑powered bots into chat interfaces.
• Education solutions: Chat solutions for edaction and learning platforms, tutor‑student interactions.
• Remote team solutions: Team‑based chat tools suited for distributed team collaboration.
• Chat API & SDKs for website: Info on using TalkJS chat APIs and SDKs to embed chat in any website.
• Virtual events solutions: Chat solutions for event platforms to support live Q&A and networking.

Languages, frameworks and integrations

• JavaScript: JavaScript library to integrate chat into websites or apps.
• Flask: Add chat to a Flask app using TalkJS.
• Ruby: Add chat to a Ruby app using TalkJS.
• React: Add chat to a React app using TalkJS.
• C#: Integrate chat and messaging into C#/.NET applications using TalkJS.
• Python: Enable messaging features in Python-based applications using TalkJS.
• Ionic: Chat integration for hybrid mobile apps built with the Ionic framework.
• ASP.NET Core: Add messaging capabilities to ASP.NET Core apps using TalkJS.
• Node.js: Integrate real-time messaging into Node.js applications using TalkJS.
• Vue.js: Embed chat components into Vue.js applications using TalkJS.
• PHP: Add messaging support to PHP backend systems with TalkJS.
• Java: Integrate messaging into Java-based applications with TalkJS.
• Livewire: Embed chat functionality into Laravel apps using Livewire components and TalkJS.
• jQuery: Add real-time chat to legacy websites built with jQuery using TalkJS.
• Angular: Embed chat into Angular applications using TalkJS.
• Laravel: Integrate messaging into Laravel backend applications using TalkJS.
• Ruby on Rails: Add chat functionality to Ruby on Rails applications using TalkJS.
• Svelte: Embed chat into Svelte applications using TalkJS.
• Flutter: Integrate real-time messaging into Flutter mobile applications using TalkJS.
• Spring Boot: Enable messaging capabilities in Java Spring Boot applications with TalkJS.
• Django: Integrate messaging features into Django-based web applications using TalkJS.
• Next.js: Add chat to React apps built with Next.js using TalkJS.
• React Native: Embed mobile chat and messaging in React Native applications using TalkJS.
• Blazor: Add chat interfaces to .NET Blazor applications using TalkJS.
• TypeScript: Implement messaging features in TypeScript-based applications using TalkJS.
• React chat UI: Customize chat user interfaces in React apps using TalkJS components.
• React component: Use TalkJS chat components in React.
• React widget: Use the TalkJS chat widget inside React applications.
• React chatbot: Build a chatbot using TalkJS in a React environment.
• Integrations: Lists third-party platforms and services that can integrate with TalkJS messaging.
• Webflow and Memberstack integration: Add TalkJS-powered chat to Webflow sites with Memberstack support.
• Wordpress: Integrate TalkJS chat into WordPress websites.

Docs

• TalkJS Documentation: Welcome page to the full TalkJS documentation with references, tutorials, SDK guides, REST API info, and support.
• Webhooks: Documentation on enabling and handling TalkJS webhook events (such as message.sent, user.created).
• Code samples: A collection of ready‑to‑use code snippets for integrating TalkJS into various frameworks and use cases.
• Chatbot interface: Guide to setting up TalkJS chatbots using webhooks and the REST API.
• Supporting mobile devices: Instructions for using TalkJS in mobile apps and webviews, including push notifications and troubleshooting.
• Environments: Explanation of TalkJS’s test mode and live mode, and how to manage credentials, publishing, and data between them.

Concepts

• Roles: Overview of user roles in TalkJS, specifying UI behaviors, permissions (such as, file sharing, mentions), and content suppression settings.
• Conversations: Explanation of conversations (1‑on‑1 or group), their structure, IDs, security considerations, and metadata.
• Message content: Description of the content field for messages, including TextBlock, FileBlock, and LocationBlock definitions.
• Participants: Details on participants in a conversation, including roles, notification settings, and access permissions.
• Guests: Explains 'guest' access, for users who can read and send messages without appearing in the participant list or receiving notifications.
• Messages: Describes the structure of a message (text, image, location) and its data fields such as id, senderId, content, and timestamps.
• System Messages: Defines system messages shown to all conversation participants with neutral formatting and specific metadata fields.
• Users: Defines what a TalkJS user is, how to map them to your own users, and outlines required and optional user data fields.
• Sessions: Covers session creation, lifecycle, security, and the data needed (like user ID, app ID, token/signature).

JavaScript Data API

• JavaScript Data API: Overview of the Data API and its use of WebSockets for real-time chat data operations in browser or Node.js environments.
• Conversations: Methods for creating, fetching, updating & subscribing to conversation resources via the JavaScript Data API.
• Message content: Explains message content blocks (text, file, location), their structure, and supported block types.
• Participants: Details participant resources in Data API: methods for adding, removing, editing participants and subscription handling.
• TalkSession: Entry point for the standalone JS Data API, used via getTalkSession to establish a session and access upload/send methods.
• Performance: Guidance on optimizing TalkJS Data API usage for performance, including session reuse and caching.
• Messages: Reference for working with individual messages via the TalkJS Data API, including edit, delete, and subscriptions.
• Users: Interface for managing users via the Data API, including creation, updating, fetching, and subscriptions.

Javascript chat SDK

• Overview: Intro to the JavaScript SDK, outlining 1‑on‑1, group, and large group chat setup.
• 1-on-1 chat: Guide for adding a one‑on‑one chat (direct messages) between two users using the JavaScript SDK.
• Group chat: Instructions for creating a group chat (3+ users) via the JavaScript SDK.
• Large group chat: Guide to building a large group chat with guest access using the JavaScript SDK.
• The JavaScript Chat SDK: Overview of the TalkJS JavaScript SDK, including installation and main chat components.
• The Talk Object: Reference for the Talk utility object.
• HtmlPanel: Details on creating and controlling HTML panels within chat UIs.
• Inbox: Documentation for the main chat inbox UI, its methods and events.
• Popup: Guide to using the popup UI component, its events, and controls.
• Chatbox: API reference for the Chatbox UI component that displays a single conversation and its events or methods.
• Session: Details on the Session class, which handles user authentication, UI creation, and event management.
• Other interfaces: Interface definitions for various chat events and helper types across SDK components.
• Classic Data API: Reference for legacy Data API classes such as User and ConversationBuilder for CRUD operations.

React Native SDK

• React Native: Guide to integrating TalkJS SDK into React Native apps for real-time chat functionality.
• Installation: Steps to install and set up the TalkJS React Native SDK.
• ConversationPredicate: Object type for filtering conversation lists based on, for example, access, unread messages, or custom fields.
• PresenceOptions: Options to configure presence features such as read-receipts visibility for React Native chat sessions.
• FieldPredicate: Definition of FieldPredicate arrays for filtering.
• CustomFieldPredicate: Defines conditions for custom fields in the React Native SDK.
• User: Represents a user with customizable attributes in the React Native SDK.
• NotificationHandler: Manages push notification events in the React Native SDK.
• UserSnapshot: Provides a snapshot of a user's attributes at a specific time.
• Message: Represents a message with content, metadata, and attachments.
• CustomPredicate: Defines custom conditions for filtering data in the React Native SDK.
• CustomData: Stores additional metadata for users, conversations, or messages.
• MessageField: Represents the message entry field in the chat UI.
• Subscription: Manages event subscriptions and unsubscriptions in the chat UI.
• CustomEmojis: Allows integration of custom emojis into the chat interface.
• UserSnapshot: Represents a snapshot of a user's attributes at a specific moment in time.
• ConversationData: Contains data associated with a conversation, such as subject and custom fields.
• ThirdPartyOptions: Provides options for integrating third-party services with TalkJS.
• ConversationBuilder: Facilitates the construction and configuration of conversations.
• ThemeOptions: Defines customization options for the appearance of the chat UI.
• registerPushNotificationHandlers: Registers handlers for push notification events in a React Native application.
• oneOnOneId: API method to get or generate a one-on-one conversation ID.
• getConversationBuilder: API function to retrieve a conversation builder instance.
• getNotificationHandler: API to access the notification handler for push notifications.
• HtmlPanel: React Native component rendering the HTML-based chat panel.
• Chatbox: Chatbox component for embedding chat in React Native apps.
• Session: Component managing the TalkJS user session in React Native.
• ConversationList: Displays a list of conversations the current user is part of.

Flutter SDK

• The Talk Object: Provides utility functions for using TalkJS in Flutter.
• User: Represents a user in your app, identified by a unique ID.
• Conversation: Represents a conversation to be created, fetched, or updated.
• The Flutter SDK: Guide to installing the Flutter SDK for TalkJS.
• Session: Manages a TalkJS session, including user and conversation handling.
• Other interfaces: Documentation of additional Flutter SDK interfaces in TalkJS.
• Chatbox: Details on the Chatbox widget for Flutter integration.
• ConversationList: Information about the ConversationList widget in Flutter.

React SDK

• Overview: Introduction and setup guide for using TalkJS with React.
• 1-on-1 chat: Guide to implementing one-on-one chat with TalkJS in React.
• Group chat: Guide to creating group chats in React using TalkJS.
• Large group chat: Guide for implementing large group chats with TalkJS in React.
• Installation: Instructions for installing the TalkJS React SDK.
• useUnreads: Documentation for the React hook to track unread messages.
• useSession: Guide to the React hook for managing TalkJS sessions.
• HtmlPanel: Details on the HtmlPanel React component for the chat UI.
• Inbox: React component for displaying a single conversation inbox.
• Popup: React component for displaying a conversation in a popup window.
• Chatbox: React component for embedding a chat interface within your application.
• Session: React component for initializing and managing a TalkJS session.

REST API

• User Presence: REST API endpoint to check the online status and activity of users.
• Rate Limiting: REST API documentation on rate limits for API requests.
• Import messages: Guide for importing messages via the REST API.
• Conversations: REST API reference for managing conversations.
• Notifications: REST API details on notification management.
• Messages: Documentation on REST API endpoints for messages.
• Batch: REST API batching operations for multiple requests.
• REST API versions: Changelog for REST API versions and updates.
• Participant: REST API reference for conversation participants.
• App: Details about the app object in the REST API.
• Users: REST API reference for managing users.
• Get started with the REST API: Introduction to using the TalkJS REST API.
• Starting a conversation: Guide on creating conversations with the REST API.
• Troubleshooting REST API requests: Tips for troubleshooting REST API issues.

Getting started guides

• Frameworks: Overview of supported frameworks for TalkJS chat integration.
• Angular: Guide to getting started with TalkJS chat in Angular projects.
• Svelte: Instructions for integrating TalkJS chat with Svelte.
• Vue: Guide on using TalkJS chat within Vue applications.
• Ionic: TalkJS chat setup and usage guide for Ionic apps.
• Other frameworks: Information on integrating TalkJS with additional frameworks.

Components

• Components: Overview of TalkJS chat components for integration.
• Installation: Instructions for installing TalkJS chat components.
• Chatbox: Detailed reference for the Chatbox UI component.
• Angular: Guide on using TalkJS chat components in Angular apps.
• Svelte: Guide on integrating TalkJS chat components with the Svelte framework.
• React: Guide for implementing TalkJS chat in React applications.
• JavaScript with no framework: Guide to using TalkJS chat components with plain JavaScript (no framework).
• Guides: Overview of various TalkJS component integration guides.
• Vue: Instructions for integrating TalkJS chat components in Vue applications.
• Next.js: Guide on using TalkJS chat components with the Next.js framework.

Themes

• Themes: Overview of TalkJS chat themes and customization options.
• Email themes: Customizing email notification themes in TalkJS.
• Passing data to themes: How to provide custom data to themes for dynamic content.
• Legacy themes (limited CSS): Details on older TalkJS themes with restricted CSS control.
• Global CSS overrides: Guide for overriding CSS globally to customize the chat UI.
• Adding New Features to Existing Themes: Instructions to upgrade and add features to current themes.
• Icons: Information about icons used within TalkJS themes.
• Template Language Reference: Reference guide for TalkJS template language syntax and usage.
• ReplyBar: Documentation on customizing the message reply input bar component.
• SystemMessage: Details about the system message component displayed in chat.
• GroupChatImage: Information on the group chat image component used in themes.
• Avatar: Overview of user avatar components in TalkJS chat themes.
• UserMessage: Description of the user message component structure and customization.
• SearchResultHeader: Details about the search result header component in themes.
• ConversationListItem: Documentation for individual conversation list items in the chat UI.
• NoSearchResults: Explains the component displayed when no search results are found.
• NoChatsScreen: Information on the screen shown when there are no conversations.
• ConversationListHeader: Details about the header component for the conversation list.
• ConversationImage: Overview of the conversation image component used in chat themes.
• Shared types: Defines shared types used across multiple components.
• ReferencedMessage: Renders the contents of a message being replied to.
• MessageBody: Displays the content of a message.
• ConversationListSearchBox: Provides a search input for filtering conversations.
• MessageField: Interface for composing and sending messages.
• Globally available subcomponents and variables: Lists components and variables accessible throughout themes.
• SearchResultFooter: Displays footer information in search results.
• MessageSearchResult: Displays individual message search results.
• ChatHeader: Shows the header section of the chat interface.
• Theme components overview: Overview of available theme components.
• RecordingPreview: Preview of audio recordings before sending.
• TypingIndicator: Shows who is currently typing in the chat.
• VoiceRecorder: Component for recording voice messages.

Notifications

• Notifications: Overview of TalkJS notification features.
• Browser Notifications: How to enable and use browser notifications.
• Mobile Push Notifications: Guide for configuring mobile push notifications.
• Email notifications: Setup and customization of email notifications.
• Customize notifications: Instructions on customizing notification behavior.
• SMS notifications: Information on SMS notification support and setup.
• Configure Apple Push Notifications: Instructions for setting up Apple Push Notifications (APNs).
• React Native push notifications: Guide to integrating push notifications in React Native apps.
• Expo: Steps to use push notifications with Expo framework.
• Flutter Push Notifications: Instructions for enabling push notifications in Flutter apps.
• Configure Firebase Cloud Messaging: Setup guide for Firebase Cloud Messaging (FCM) service.
• Email notification themes: Customization options for email notification themes.
• Unsubscribe link customization: Guide on customizing unsubscribe links in email notifications.
• Link back to your app: Instructions for linking email notifications back to your app.

Pre-built chat UIs

• Chat UIs: Overview of available pre-built chat user interfaces.
• Popup: Details on the popup chat widget UI mode.
• The Chatbox: Information about the Chatbox user interface mode.
• Switch between conversations: How to switch between conversations within a chat app.
• Embeddable read-only conversation: Guide to embedding a read-only chat conversation widget.
• Resize chat UI: Instructions on positioning chat UI components on a page.
• Inbox: Overview of the Inbox chat user interface mode.

Group chat

• Group chats: Explanation of group chat functionality and features.
• Access rights: Details on managing user permissions in group chats.
• Create a group chat: Step-by-step guide to creating group chats.
• Add or remove users to or from a group chat: Instructions for managing group chat membership.

Security

• Advanced authentication: Details on implementing advanced user authentication methods.
• Browser synchronization: Explanation of syncing user sessions across multiple browsers.
• Secret Keys: Information on managing and using secret keys securely.
• Security recommendations: Best practices and guidelines for enhancing security.
• Content Security Policy: Guide to implementing a Content Security Policy (CSP) for improved security.
• Authentication: Overview of authentication mechanisms supported by TalkJS.

Conversation features

• Search messages & conversations: Guide to enabling and using search for both messages and conversations.
• Conversation Actions: Details on built-in and custom actions users can perform within a conversation.
• Closing a Conversation: Explains how to effectively “close” a chat by revoking write access.
• Status Indicator: Shows how to display an online or offline user status in conversations.

Message features

• Message field options: Explains customization of the message input field (suggestions, visibility, autofocus).
• Emoji reactions: Describes enabling emoji reactions and adding custom emojis to messages.
• File sharing: Explains enabling file sharing in the chat UI.
• Voice messages: Guide for recording and sending voice messages, including UI behavior.
• Formatting: Documents wiki-style text formatting (bold, italic, lists, code).
• Message Actions: Describes action menus on messages and role‑based permissions.
• Link previews: Shows how chat can auto‑generate preview cards for URLs.
• Mentions: Details @‑mention support with autocomplete and role controls.
• The Theme Editor: Interface for customizing the TalkJS chat UI themes directly in the browser.
• Editing Component Templates: Guide to modifying HTML and CSS templates for individual UI components.

Localization and real-time translation

• Localization: Explains how to display TalkJS UIs in different languages, including RTL support.
• Real-time message translation: Details setup for automatic message translation.

Customizations

• Custom headers: Instructions for replacing or extending the default chat header component.
• Action Buttons and Links: Enables adding custom interactive buttons or links within chat messages.
• HTML panels: Guide for embedding interactive HTML content (such as forms or widgets) via iframes.
• Conversation list filters: Describes how to filter which conversations appear in the chat UI.
• Message filters: Explains filtering messages by sender, type, time, etc. in chat components.
• Third Party Integrations: Shows how to integrate services like FullStory to work with TalkJS UIs.

Optional

• Login: Admin dashboard login for existing TalkJS customers.
• Product updates: Overview of posts with new TalkJS chat features and SDK improvements.
• Product comparison: Overview of posts showing how TalkJS chat compares to alternatives.
• Customers: Page showcasing TalkJS’s customer stories and case studies.