--- title: "Realtime WebSocket API" description: "Subscribe to Appwrite events over one WebSocket connection. Realtime brings type-safe channels, server-side query filters, live presence, and permission-aware events to every Appwrite service." canonical: "https://appwrite.io/products/realtime" --- # Everything in Appwrite is realtime Rows, files, function executions, sessions, teams, and presence all emit events on the same WebSocket. Subscribe once, get changes in milliseconds instead of polling, and only ever receive what the user can read. [Start building](https://appwrite.io/sign-up?redirect=%2F)[View docs](https://appwrite.io/docs/apis/realtime) Appwrite events * Databasesrows * Storagefiles * Functionsexecutions * Authaccount * Presencepresences Appwrite events Realtime 1 WebSocket Web app Mobile app Dashboard Not just databases Every service Shared by all subscriptions 1 socket From write to subscriber Milliseconds Filtered server-side Queries Live online status Presence ## One connection, many subscriptions Create a Realtime client once and every subscription shares a single WebSocket. Add one with subscribe(), swap its channels or queries with update(), and drop it with unsubscribe(), all without reconnecting. [Subscribe docs](https://appwrite.io/docs/apis/realtime/subscribe) rowsfilespresences Realtime client 1 WebSocket Add a subscription await realtime.subscribe(Channel.files()) ## Every service publishes to a channel Databases, Storage, Functions, Auth, teams, and presence all stream on the same socket. The Channel helper builds the string with a fluent API, so leave an ID blank for a wildcard or append .create() to narrow the stream. ### Databases * Channel.tablesdb('main').table('orders').row() tablesdb..tables..rows * Channel.tablesdb('main').table('orders').row('8f2a') tablesdb..tables..rows. * Channel.rows() rows ### Storage * Channel.bucket('media').file() buckets..files * Channel.bucket('media').file('invoice') buckets..files. * Channel.files() files ### Functions * Channel.executions() executions * Channel.function('checkout') functions. * Channel.executions().create() executions.create ### Auth, teams, and presence * Channel.account() account * Channel.teams() teams.\* * Channel.presences() presences [Channels docs](https://appwrite.io/docs/apis/realtime/channels) ## Filter events before they reach you Pass queries when you subscribe and Appwrite filters events on the server, so your callback only runs for updates that match. The methods are the ones you already use for lists, from equal to isNull and or. [Realtime queries docs](https://appwrite.io/docs/apis/realtime/queries) Events on the channel * person: 'paige'match * person: 'walter'dropped * person: 'paige'match Filtered on the server \[Query.equal('person', \['paige'\])\] ## Presence that is durable and live A presence record carries a user, a free-form status, optional metadata, and an expiry. List presences to see who is here, and subscribe for upsert, update, and delete events in milliseconds. [Presences docs](https://appwrite.io/docs/apis/realtime/presences) Who is here presences * PApaige@example.comediting * WAwalter@example.comonline * HAhappy@example.comaway expiresAt Slides on heartbeat ## A predictable payload on every event Every message carries the events that triggered it, the channels that can receive it, a server timestamp, and a payload matching the resource response model. Branch on the event names, then apply the payload. [Payload docs](https://appwrite.io/docs/apis/realtime/payload) Every message carries eventsstring\[\] \['tablesdb.main.tables.orders.rows.8f2a.update'\] channelsstring\[\] \['rows', 'tablesdb.main.tables.orders.rows'\] payloadobject { $id: '8f2a', status: 'paid' } ## Permission-aware subscriptions Subscriptions use the same permissions as the rest of Appwrite, so a user only receives updates for resources they can read. Realtime uses the session you had when you subscribed, so reconnect when it changes. [Realtime authentication docs](https://appwrite.io/docs/apis/realtime/authentication) Row updated Permission.read(Role.team('acme')) paige@example.com Event delivered toby@example.com Nothing delivered ## Tools built for developers and agents API-first by design. Use the Console, Realtime, SDKs, CLI, Terraform, MCP, and agent skills on the same project. Developer and agent experience One WebSocket, filtered server-side. TypeScript ``` import { Client, Realtime, Channel, Query } from 'appwrite'; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') .setProject(''); const realtime = new Realtime(client); const subscription = await realtime.subscribe( Channel.tablesdb('').table('orders').row(), (response) => { console.log(response.events, response.payload); }, [Query.equal('status', 'paid')],); ``` [Everything is an APIREST, GraphQL, and SDKs for every service. Automate and integrate without console-only workflows.](https://appwrite.io/docs/apis/rest)[ConsoleManage every service in your project from a unified Console. Optimized keyboard access and a Command Center keep you moving fast.⌘KCommand Center](https://appwrite.io/docs/tooling/command-center)[RealtimeSubscribe to live events and react to changes as they happen.tablesdb.\*.tables.\*.rows.\*tablesdb.\*.tables.\*.rows.\*.create](https://appwrite.io/docs/apis/realtime)[MCPConnect AI agents to your Appwrite project, APIs, and docs through one remote MCP server.appwrite https://mcp.appwrite.io](https://appwrite.io/docs/tooling/ai/mcp-servers)[TerraformManage Appwrite infrastructure as code with the official provider.terraform plan terraform apply](https://appwrite.io/docs/tooling/terraform/resources/databases)[Agent skillsGive AI agents SDK-accurate knowledge of Appwrite services and APIs.npx skills add appwrite/skills](https://appwrite.io/docs/tooling/ai/skills)[SDKsClient and server SDKs for the platforms your team already uses. 15 official SDKs available across client and server runtimes.](https://appwrite.io/docs/sdks)[CLIDeploy resources, manage projects, and generate typed SDKs from your terminal.appwrite login appwrite deploy](https://appwrite.io/docs/tooling/command-line/installation) ## FAQ ### Realtime is a third protocol for talking to Appwrite, alongside REST and GraphQL. Instead of requesting new data over HTTP, you subscribe once and the server pushes new data to every connected client over a WebSocket as soon as it changes. Subscriptions cover events from all of Appwrite services, not just databases. [Realtime overview](https://appwrite.io/docs/apis/realtime)[REST API](https://appwrite.io/docs/apis/rest)[GraphQL API](https://appwrite.io/docs/apis/graphql) ### Client SDKs use a single WebSocket per Realtime client for all subscriptions. Adding one with subscribe(), replacing its channels or queries with update(), and dropping it with unsubscribe() all apply on the existing socket where supported, so there is no full reconnect. The connection closes when you call realtime.disconnect(). [Subscribe docs](https://appwrite.io/docs/apis/realtime/subscribe) ### Every service publishes channels: account and sessions, teams and memberships, rows, files, function executions, and presences. The Channel helper class builds the channel string for you with a fluent API, so you can target one row or every row in a table. Leave an ID blank to subscribe with a wildcard, and append .create(), .update(), or .delete() to narrow the stream to a single event type. [Channels docs](https://appwrite.io/docs/apis/realtime/channels)[Events reference](https://appwrite.io/docs/apis/events) ### Yes. Pass queries as a third parameter when you subscribe and Appwrite filters events server-side, so your callback only runs for updates that match. Realtime supports Query.equal, Query.notEqual, the greater than and less than comparisons, Query.isNull, Query.isNotNull, Query.and, and Query.or. [Realtime queries docs](https://appwrite.io/docs/apis/realtime/queries) ### Every message carries four properties: events (the Appwrite events that triggered the update), channels (the channels that can receive it), timestamp (an ISO 8601 time in UTC from the server), and payload (the same data as the matching response model). Branch on the event names in events to decide how to update your UI. [Payload docs](https://appwrite.io/docs/apis/realtime/payload)[Events reference](https://appwrite.io/docs/apis/events) ### No. Every subscription is secured by the same permissions system used by rows, files, and presences, so a user only receives updates for resources they have permission to access. Granting read to Role.any() is what makes a resource stream to any client, including visitors who are not signed in. [Realtime authentication docs](https://appwrite.io/docs/apis/realtime/authentication)[Permissions](https://appwrite.io/docs/advanced/security/permissions) ### Realtime authenticates with the session that existed when the subscription was created. If you authenticate after subscribing, that subscription will not receive updates for the new user, so create the session first. When a user signs out and another signs in, call realtime.disconnect() and subscribe again for the new session. [Realtime authentication docs](https://appwrite.io/docs/apis/realtime/authentication) ### A presence is a short-lived record tied to a user, with a userId, a free-form status, optional metadata, and an expiresAt timestamp. It is durable, so you can list presences at any time, and live, so every change fires upsert, update, and delete events. Keep a record alive with a heartbeat, or use realtime.upsertPresence() so it is removed when the connection closes. [Presences docs](https://appwrite.io/docs/apis/realtime/presences)[Auth presences](https://appwrite.io/docs/products/auth/presences) ### Not today. Realtime subscriptions are a client SDK feature and are not offered for Server SDKs with an API key. Presence records are the exception: they are also a regular HTTP resource, so server code can write them with an API key that has the presences.write scope and clients will see the change live. [Realtime overview](https://appwrite.io/docs/apis/realtime)[Presences docs](https://appwrite.io/docs/apis/realtime/presences) ### Yes. The SDK derives the Realtime endpoint from your Appwrite endpoint, which is wss://.cloud.appwrite.io/v1/realtime by default. If you run Appwrite behind a custom proxy and moved the Realtime route, call setEndpointRealtime on the client with your own value. [Custom endpoint docs](https://appwrite.io/docs/apis/realtime/custom-endpoint) ## Start building with Realtime Subscribe to your first channel and watch rows, files, executions, and presence updates arrive as they happen. [Start building](https://appwrite.io/sign-up?redirect=%2F)[View pricing](https://appwrite.io/pricing) ## Explore Appwrite Modular backend services that share the same project, permissions model, and console. [AuthEmail, OAuth, SMS, MFA, teams, and sessions.](https://appwrite.io/products/auth) [DatabasesManaged PostgreSQL, TablesDB, DocumentsDB, VectorsDB, MySQL.](https://appwrite.io/products/databases) [PostgreSQLManaged PostgreSQL with pooling, replicas, and PITR.](https://appwrite.io/products/postgres) [StorageUpload, transform, and deliver files on CDN.](https://appwrite.io/products/storage) [FunctionsAPIs, cron jobs, and event handlers at scale.](https://appwrite.io/products/functions) [MessagingEmail, SMS, and push with topics and targets.](https://appwrite.io/products/messaging) [RealtimeLive events, channels, and presence.](https://appwrite.io/products/realtime) [SitesStatic, SSR, and CSR deploys from Git.](https://appwrite.io/products/sites) [DomainsSearch, buy, transfer, and manage domains.](https://appwrite.io/domains) [FirewallProject rules to deny, rate limit, and redirect traffic.](https://appwrite.io/products/firewall) ### ### ### ### ### ### [](https://github.com/appwrite)[](https://x.com/appwrite)[](https://youtube.com/@appwrite)[](https://www.linkedin.com/company/appwrite/)[](https://www.instagram.com/appwrite.io/)[](https://appwrite.io/discord)[](https://apwr.dev/dailydev) [SOC 2 Type II Certified](https://appwrite.io/docs/advanced/security) © 2026 Appwrite