# Sublay Documentation: 7.0.0 ## 7.0.0 - [7.0.0 / Hooks Reference (207 pages)](https://docs.sublay.io/_llms/7-0-0/hooks-reference.md): Documentation for 7.0.0 / Hooks Reference. - [7.0.0 / API Reference (206 pages)](https://docs.sublay.io/_llms/7-0-0/api-reference.md): Documentation for 7.0.0 / API Reference. ### Overview #### Getting Started - [Introduction](https://docs.sublay.io/v7/index.md): Sublay is infrastructure for user-powered applications — auth, social graph, content, chat, community spaces, and more, pre-built and ready to integrate. - [Bundles](https://docs.sublay.io/v7/bundles.md): Sublay features are modular. Each project is assembled from bundles — groups of features you install per project and can add or remove at any time. - [Integration Options](https://docs.sublay.io/v7/integration-options.md): The different ways to integrate Sublay — SDK, raw REST API, and Redux store integration. - [Authentication](https://docs.sublay.io/v7/authentication.md): How Sublay handles user identity — built-in auth, external JWT integration, and OAuth. - [Webhooks](https://docs.sublay.io/v7/webhooks.md): How Sublay calls your server — event notifications, validation hooks, and signature verification. - [Push Notifications](https://docs.sublay.io/v7/push-notifications.md): Deliver native OS push notifications to your users on iOS, Android, and Web — from a single server-side call. - [Notification Preferences & Mute](https://docs.sublay.io/v7/notification-preferences.md): Automatic push fan-out for in-app events, per-user type toggles, per-conversation mute, and developer-authored copy templates. - [Custom Tables](https://docs.sublay.io/v7/custom-tables.md): Provision your own database tables for the remaining 20% of your data model — with SDK row access, table management, and a full dashboard data editor - [Semantic Search & AI](https://docs.sublay.io/v7/semantic-search-ai.md): Automatic content embedding and semantic search across entities, comments, messages, users, and spaces — plus an AI-powered ask endpoint. - [Interest Matching](https://docs.sublay.io/v7/interest-matching.md): Match people by what they actually engage with — activity-derived interest facets, decayed over time, matched passively or by topic. - [MCP Server](https://docs.sublay.io/v7/mcp-server.md): Integrate Sublay documentation into AI tools like Claude Code, Cursor, and Windsurf using the Model Context Protocol. - [Claude Code Plugin](https://docs.sublay.io/v7/claude-code.md): Install the Sublay plugin for Claude Code to give your coding agent an accurate, built-in map of the Sublay platform. ### SDK Reference #### Setup - [Getting Started](https://docs.sublay.io/v7/sdk/getting-started.md): Install the Sublay SDK and add SublayProvider to your app - [Redux Integration](https://docs.sublay.io/v7/sdk/redux-integration.md): Merge Sublay's Redux state into your existing store using SublayIntegrationProvider #### Authentication - [Overview](https://docs.sublay.io/v7/sdk/authentication/overview.md): Auth state, sign-up/in/out, and the token model - [Built-in Auth](https://docs.sublay.io/v7/sdk/authentication/built-in.md): Email/password sign-up, sign-in, and sign-out flows - [External Auth](https://docs.sublay.io/v7/sdk/authentication/external.md): Integrating your own auth system via signed JWT - [OAuth](https://docs.sublay.io/v7/sdk/authentication/oauth.md): Google, GitHub, Apple, and Facebook OAuth provider integration - [Configuring OAuth Providers](https://docs.sublay.io/v7/sdk/authentication/oauth-providers/overview.md): Register your app with Google, GitHub, Apple, or Facebook and wire the credentials into the Sublay dashboard - [Apple](https://docs.sublay.io/v7/sdk/authentication/oauth-providers/apple.md): Set up Sign in with Apple: Services ID, key, Team ID, and Key ID - [Google](https://docs.sublay.io/v7/sdk/authentication/oauth-providers/google.md): Create an OAuth 2.0 client in the Google Cloud Console and wire it into Sublay - [GitHub](https://docs.sublay.io/v7/sdk/authentication/oauth-providers/github.md): Create a GitHub OAuth App and paste the client ID and secret into Sublay - [Facebook](https://docs.sublay.io/v7/sdk/authentication/oauth-providers/facebook.md): Create a Meta app with Facebook Login and paste the App ID and secret into Sublay - [Multi-Account](https://docs.sublay.io/v7/sdk/authentication/multi-account.md): Managing multiple user accounts in a single app instance #### Users - [Current User](https://docs.sublay.io/v7/sdk/users/current-user.md): Reading and updating the authenticated user's own profile - [User Profiles](https://docs.sublay.io/v7/sdk/users/user-profiles.md): Fetch and search public profiles of other users in your project #### Entities - [Overview](https://docs.sublay.io/v7/sdk/entities/overview.md): The central content unit in Sublay — posts, articles, products, listings, and anything else your app centers around - [EntityProvider & useEntity](https://docs.sublay.io/v7/sdk/entities/provider-and-hook.md): Load a single entity and access its state and actions from any child component - [Drafts & Publishing](https://docs.sublay.io/v7/sdk/entities/drafts-and-publishing.md): Create entities as drafts and publish them when ready #### Entity Lists - [Overview](https://docs.sublay.io/v7/sdk/entity-lists/overview.md): Paginated, filtered, sorted feeds of entities with infinite scroll support - [Fetching Entities](https://docs.sublay.io/v7/sdk/entity-lists/fetch-entities.md): Loading, paginating, sorting, and managing entities in a list - [Infusing Data](https://docs.sublay.io/v7/sdk/entity-lists/infuse-data.md): Merging Sublay entity data with data from your own backend - [Filters](https://docs.sublay.io/v7/sdk/entity-lists/filters.md): Complete filter reference for entity list queries #### Comments - [Overview](https://docs.sublay.io/v7/sdk/comments/overview.md): Threaded comment sections using CommentSectionProvider and useCommentSection - [Comment Section](https://docs.sublay.io/v7/sdk/comments/comment-section.md): CommentSectionProvider setup and the useCommentSection hook reference #### Reactions - [Overview](https://docs.sublay.io/v7/sdk/reactions/overview.md): The 8-type reaction system for entities and comments #### Reputation - [Reputation Grants Overview](https://docs.sublay.io/v7/sdk/reputation/overview.md): Give, list, and display reputation grants with the React SDK #### Spaces - [Overview](https://docs.sublay.io/v7/sdk/spaces/overview.md): Build community spaces with membership, moderation, rules, and optional chat - [SpaceProvider & useSpace](https://docs.sublay.io/v7/sdk/spaces/provider-and-hook.md): Load a space into React context and access its state, permissions, and operations - [Membership](https://docs.sublay.io/v7/sdk/spaces/membership.md): Join and leave spaces, manage members, handle approval workflows, and assign roles - [Moderation](https://docs.sublay.io/v7/sdk/spaces/moderation.md): Moderate content and handle reports within a space - [Rules](https://docs.sublay.io/v7/sdk/spaces/rules.md): Create and manage community rules visible to all space members - [Space Lists](https://docs.sublay.io/v7/sdk/spaces/space-lists.md): Browse, search, and paginate spaces with filtering and sorting #### Workspaces - [Overview](https://docs.sublay.io/v7/sdk/workspaces/overview.md): Build SaaS/team workspaces with invitations, per-member authority, and self-nesting - [Webhooks & lifecycle](https://docs.sublay.io/v7/sdk/workspaces/webhooks.md): The workspace webhook event catalog, the member.* vs invite.* streams, and uninstall behavior #### Events - [Events Overview](https://docs.sublay.io/v7/sdk/events/overview.md): Create, list, and manage events with the React SDK - [EventProvider & useEvent](https://docs.sublay.io/v7/sdk/events/provider-and-hook.md): Load a single event into React context with bound RSVP and management actions #### Chat - [Overview](https://docs.sublay.io/v7/sdk/chat/overview.md): Real-time 1:1 and group messaging with reactions, threading, and typing indicators - [Chat Setup](https://docs.sublay.io/v7/sdk/chat/setup.md): Add ChatProvider to your app to enable real-time messaging - [Conversations](https://docs.sublay.io/v7/sdk/chat/conversations.md): Create, list, and manage direct and group conversations - [Messages](https://docs.sublay.io/v7/sdk/chat/messages.md): Send, load, edit, delete, and react to messages in a conversation - [Real-time Features](https://docs.sublay.io/v7/sdk/chat/real-time.md): Typing indicators, unread counts, and marking conversations as read - [Message Threads](https://docs.sublay.io/v7/sdk/chat/threads.md): Threading replies under a parent message #### Collections - [Overview](https://docs.sublay.io/v7/sdk/collections/overview.md): Personal hierarchical bookmark system for saving entities - [Managing Collections](https://docs.sublay.io/v7/sdk/collections/managing-collections.md): Navigating, creating, and managing the collection hierarchy #### Relationships - [Overview](https://docs.sublay.io/v7/sdk/relationships/overview.md): Add follows and connections to your app with Sublay's social graph hooks - [useFollowManager](https://docs.sublay.io/v7/sdk/relationships/use-follow-manager.md): High-level hook for managing follow state with a single user - [useConnectionManager](https://docs.sublay.io/v7/sdk/relationships/use-connection-manager.md): High-level hook for managing the full connection lifecycle with a single user - [useBlockManager](https://docs.sublay.io/v7/sdk/relationships/use-block-manager.md): High-level hook for managing block state with a single user #### App Notifications - [Overview](https://docs.sublay.io/v7/sdk/app-notifications/overview.md): In-app notification records triggered by user interactions and system events - [Notifications Hook](https://docs.sublay.io/v7/sdk/app-notifications/hook.md): Fetch, paginate, and manage app notifications with useAppNotifications - [Notification Templates](https://docs.sublay.io/v7/sdk/app-notifications/notification-templates.md): Customize the display text shown for each notification type - [Webhook Integration](https://docs.sublay.io/v7/sdk/app-notifications/webhook-integration.md): Forward app notification events to your backend for push delivery #### Push Notifications - [Push Notifications](https://docs.sublay.io/v7/sdk/push-notifications/overview.md): Register the current user's device for native push from your client app #### Search & AI - [Overview](https://docs.sublay.io/v7/sdk/search/overview.md): Semantic search and AI-powered Q&A over your project content - [Semantic Search](https://docs.sublay.io/v7/sdk/search/semantic-search.md): Search content, users, and spaces with natural language queries - [Ask Content](https://docs.sublay.io/v7/sdk/search/ask.md): AI-powered question answering over your project's embedded content #### Storage - [Overview](https://docs.sublay.io/v7/sdk/storage/overview.md): Upload, retrieve, and manage files and images in Sublay #### Moderation - [Overview](https://docs.sublay.io/v7/sdk/moderation/overview.md): Content reporting and moderation tools at the project and space level - [Suspensions](https://docs.sublay.io/v7/sdk/moderation/suspensions.md): Platform-wide user suspensions — the enforced timeout for participation #### Custom Tables - [Overview](https://docs.sublay.io/v7/sdk/tables/overview.md): Read and write your project's custom-table rows from React and React Native with useTable ### Data Models #### Models - [User](https://docs.sublay.io/v7/data-models/user.md): The User, AuthUser, and UserFull interface shapes returned by the API and SDK - [Reputation](https://docs.sublay.io/v7/data-models/reputation.md): Per-space reputation buckets, the maintained overall total, and the opt-in read contract for space-scoped reputation - [ReputationGrant](https://docs.sublay.io/v7/data-models/reputation-grant.md): The record of a single deliberate reputation movement — a user transfer or an app mint - [Entity](https://docs.sublay.io/v7/data-models/entity.md): The Entity interface shape returned by the API and SDK - [Comment](https://docs.sublay.io/v7/data-models/comment.md): The Comment interface shape returned by the API and SDK - [Space](https://docs.sublay.io/v7/data-models/space.md): The shape of a Space object returned by the Spaces API and SDK - [Space Member](https://docs.sublay.io/v7/data-models/space-member.md): The shape of a SpaceMember object returned by the Spaces membership API - [Rule](https://docs.sublay.io/v7/data-models/rule.md): The Rule interface shape for space community rules - [Event](https://docs.sublay.io/v7/data-models/event.md): The shape of an Event object returned by the Events API and SDKs - [EventRsvp](https://docs.sublay.io/v7/data-models/event-rsvp.md): The shape of an EventRsvp record returned by the event guest-list endpoint - [EventInvite](https://docs.sublay.io/v7/data-models/event-invite.md): The shape of an EventInvite record returned by the event invitee-list endpoint - [Conversation](https://docs.sublay.io/v7/data-models/conversation.md): The shape of a conversation object returned by the Chat API and SDK - [ConversationMember](https://docs.sublay.io/v7/data-models/conversation-member.md): The shape of a conversation membership record returned by the Chat API and SDK - [ChatMessage](https://docs.sublay.io/v7/data-models/chat-message.md): The shape of a chat message object returned by the Chat API and SDK - [Collection](https://docs.sublay.io/v7/data-models/collection.md): A named folder in a user's personal save library for organizing entities - [Reaction](https://docs.sublay.io/v7/data-models/reaction.md): ReactionType, ReactionCounts, and the Reaction record interface - [File](https://docs.sublay.io/v7/data-models/file.md): The File and FileImage interface shapes for uploaded media - [Follow](https://docs.sublay.io/v7/data-models/follow.md): The Follow interface shape representing a user following another user - [Connection](https://docs.sublay.io/v7/data-models/connection.md): Connection interface shapes for bidirectional user relationships - [Block](https://docs.sublay.io/v7/data-models/block.md): The Block interface shape representing one user blocking another - [App Notification](https://docs.sublay.io/v7/data-models/app-notification.md): The AppNotification interface shape including all notification types and their metadata - [Workspace](https://docs.sublay.io/v7/data-models/workspace.md): The shape of a Workspace object returned by the Workspaces API and SDK - [Workspace Member](https://docs.sublay.io/v7/data-models/workspace-member.md): The shape of a WorkspaceMember object, plus the capability vocabulary, permissions, and rank semantics - [Workspace Invitation](https://docs.sublay.io/v7/data-models/workspace-invitation.md): The shape of a WorkspaceInvitation object, plus the identity-matched, no-token acceptance model ### Node SDK #### Getting Started - [Node.js SDK](https://docs.sublay.io/v7/node-sdk/overview.md): Server-side SDK for Sublay — use in backend APIs, server actions, webhooks, and scheduled jobs #### Modules - [Auth](https://docs.sublay.io/v7/node-sdk/auth.md): Sign users up, sign them in, manage tokens, and handle password resets from your server - [Users](https://docs.sublay.io/v7/node-sdk/users.md): Fetch, update and delete user profiles, check usernames, and query follow and connection graphs - [Entities](https://docs.sublay.io/v7/node-sdk/entities.md): Create and manage content entities, reactions, drafts, and view counts from your server - [Comments](https://docs.sublay.io/v7/node-sdk/comments.md): Create, fetch, update, delete comments, and manage reactions from your server - [Collections](https://docs.sublay.io/v7/node-sdk/collections.md): Organize a user's saved entities into a tree of collections from your server - [Follows](https://docs.sublay.io/v7/node-sdk/follows.md): Read a user's follow graph and remove follows by ID from your server - [Connections](https://docs.sublay.io/v7/node-sdk/connections.md): Query and respond to a user's mutual connections from your server - [Spaces](https://docs.sublay.io/v7/node-sdk/spaces.md): Create and manage spaces, navigate hierarchies, and look up spaces by slug or short ID - [Space Members](https://docs.sublay.io/v7/node-sdk/spaces-members.md): Manage space membership — joining, leaving, approvals, role assignments, and bans - [Space Moderation](https://docs.sublay.io/v7/node-sdk/spaces-moderation.md): Handle reports, moderate content, and manage community rules - [Workspaces](https://docs.sublay.io/v7/node-sdk/workspaces.md): Full server-side workspace surface — CRUD, membership, invitations, and authority-as-a-service - [Events](https://docs.sublay.io/v7/node-sdk/events.md): Create and manage events, RSVPs, hosts, and invites from the server - [Reputation](https://docs.sublay.io/v7/node-sdk/reputation.md): Transfer, mint, and list reputation grants from the server - [Chat](https://docs.sublay.io/v7/node-sdk/chat.md): Conversations, messages, members, reactions, and read state from your server - [Search](https://docs.sublay.io/v7/node-sdk/search.md): Full-text search across content, users, and spaces, plus AI-powered Q&A - [Reports](https://docs.sublay.io/v7/node-sdk/reports.md): File content reports on behalf of a user and read the moderated report queue from your server - [App Notifications](https://docs.sublay.io/v7/node-sdk/app-notifications.md): Read a user's in-app notifications and mark them as read from your server - [Push Notifications](https://docs.sublay.io/v7/node-sdk/push-notifications.md): Send push notifications to your users' registered devices from your backend - [Storage](https://docs.sublay.io/v7/node-sdk/storage.md): Upload, retrieve, and delete files and images from your server - [Tables — Rows](https://docs.sublay.io/v7/node-sdk/tables.md): Read and write custom-table rows from your server with the client.table(name) accessor - [Tables — Management](https://docs.sublay.io/v7/node-sdk/tables-management.md): Create and drop custom tables and columns from your server with the client.tables module ### JS SDK #### Getting Started - [JavaScript SDK](https://docs.sublay.io/v7/js-sdk/overview.md): Framework-agnostic, user-authenticated SDK for Sublay — use in any browser app or JS runtime #### Modules - [Auth](https://docs.sublay.io/v7/js-sdk/auth.md): Sign up, sign in, manage tokens, and handle password and email-verification flows for the end user - [Users](https://docs.sublay.io/v7/js-sdk/users.md): Fetch and update user profiles, check usernames, and act on a specific user's follow and connection graph - [Entities](https://docs.sublay.io/v7/js-sdk/entities.md): Create and manage content entities, reactions, and drafts - [Comments](https://docs.sublay.io/v7/js-sdk/comments.md): Create and manage threaded comments and reactions - [Collections](https://docs.sublay.io/v7/js-sdk/collections.md): Organize the logged-in user's saved entities into a tree of collections - [Follows](https://docs.sublay.io/v7/js-sdk/follows.md): Read and manage the logged-in user's own follow graph - [Connections](https://docs.sublay.io/v7/js-sdk/connections.md): Read and manage the logged-in user's own connections and pending requests - [Spaces](https://docs.sublay.io/v7/js-sdk/spaces.md): Create, fetch, update, and navigate spaces from the browser - [Space Members](https://docs.sublay.io/v7/js-sdk/spaces-members.md): Join and leave spaces, and manage roles, approvals, and bans - [Space Moderation](https://docs.sublay.io/v7/js-sdk/spaces-moderation.md): Resolve reports, moderate content, and manage rules - [Workspaces](https://docs.sublay.io/v7/js-sdk/workspaces.md): Framework-agnostic client surface for workspaces — the full 21-endpoint bundle - [Events](https://docs.sublay.io/v7/js-sdk/events.md): Create and manage events, RSVPs, hosts, and invites from the browser - [Reputation](https://docs.sublay.io/v7/js-sdk/reputation.md): Give and list reputation grants from the browser - [Chat](https://docs.sublay.io/v7/js-sdk/chat.md): Conversations, messages, members, reactions, and read state - [Push Notifications](https://docs.sublay.io/v7/js-sdk/push-notifications.md): Read and update the signed-in user's push notification preferences - [Search](https://docs.sublay.io/v7/js-sdk/search.md): Semantic search across content, users, and spaces, plus streaming AI Q&A - [Reports](https://docs.sublay.io/v7/js-sdk/reports.md): File content reports against entities and comments, and read the moderation queue - [App Notifications](https://docs.sublay.io/v7/js-sdk/app-notifications.md): Read and mark the authenticated user's in-app notifications - [Storage](https://docs.sublay.io/v7/js-sdk/storage.md): Upload, retrieve, and delete files and images from the browser - [OAuth](https://docs.sublay.io/v7/js-sdk/oauth.md): OAuth sign-in and account-linking redirect flows, and managing linked identities - [Tables](https://docs.sublay.io/v7/js-sdk/tables.md): Read and write custom-table rows from any browser or JS runtime with the client.table(name) accessor ### Components #### Overview - [Components Overview](https://docs.sublay.io/v7/components/overview.md): Own your components with Sublay's CLI-based distribution system #### Installation - [CLI Setup](https://docs.sublay.io/v7/components/installation/cli-setup.md): Install and configure the Sublay CLI - [Configuration](https://docs.sublay.io/v7/components/installation/configuration.md): Understanding the sublay.json configuration file - [Quick Start](https://docs.sublay.io/v7/components/installation/quick-start.md): Get comment components running in under 5 minutes #### Component Types - [Component Types](https://docs.sublay.io/v7/components/components/overview.md): Choose the right comment style for your application #### Threaded Comments - [Threaded Comments Overview](https://docs.sublay.io/v7/components/components/threaded/overview.md): Reddit-style threaded comment system with unlimited nesting - [Installing Threaded Comments](https://docs.sublay.io/v7/components/components/threaded/installation.md): Add Reddit-style threaded comments to your project - [Props & API](https://docs.sublay.io/v7/components/components/threaded/props-api.md): ThreadedCommentSection component props and configuration - [File Structure](https://docs.sublay.io/v7/components/components/threaded/file-structure.md): Understanding the threaded comments file organization - [Features](https://docs.sublay.io/v7/components/components/threaded/features.md): Explore all threaded comments features #### Social Comments - [Social Comments Overview](https://docs.sublay.io/v7/components/components/social/overview.md): Instagram-style social comment system - [Installing Social Comments](https://docs.sublay.io/v7/components/components/social/installation.md): Add Instagram-style social comments to your project - [Social Comments Props](https://docs.sublay.io/v7/components/components/social/props-api.md): SocialCommentSection props and API - [Social Comments File Structure](https://docs.sublay.io/v7/components/components/social/file-structure.md): File organization for social comments - [Social Comments Features](https://docs.sublay.io/v7/components/components/social/features.md): Feature overview for social comments #### Notification Control - [Notification Control Overview](https://docs.sublay.io/v7/components/components/notifications/overview.md): Dropdown notification bell control for real-time app notifications - [Installing Notification Control](https://docs.sublay.io/v7/components/components/notifications/installation.md): Add notification dropdown to your project - [Props & API Reference](https://docs.sublay.io/v7/components/components/notifications/props-api.md): NotificationControl component props and configuration - [Customization Guide](https://docs.sublay.io/v7/components/components/notifications/customization.md): Customize notification control appearance and behavior - [Integration Examples](https://docs.sublay.io/v7/components/components/notifications/integration-examples.md): Real-world notification control integration examples #### Customization - [Customization Overview](https://docs.sublay.io/v7/components/customization/overview.md): Customize components to match your brand - [Colors & Theming](https://docs.sublay.io/v7/components/customization/colors-theming.md): Customize colors and implement dark mode - [Layout & Structure](https://docs.sublay.io/v7/components/customization/layout-structure.md): Modify component layout and structure - [Styling Variants](https://docs.sublay.io/v7/components/customization/styling-variants.md): Inline styles vs Tailwind CSS - [Adding Features](https://docs.sublay.io/v7/components/customization/adding-features.md): Add custom functionality to components - [Advanced Customization](https://docs.sublay.io/v7/components/customization/advanced.md): Advanced techniques for customizing Sublay components ## Optional - [Dashboard](https://dash.sublay.io)