Channels

Channels define which Appwrite resources you want to subscribe to. When subscribing to a channel, you will receive callbacks for events related to that channel's resources. The Appwrite SDKs provide a Channel helper class to build type-safe channel subscriptions using a fluent API.

Channel helpers

Instead of manually writing channel strings, you can use the Channel helper class to build type-safe channel subscriptions. The helper provides a fluent API that makes it easier to construct channel strings and reduces errors.

import { Client, Realtime, Channel } from "appwrite";

const client = new Client()
    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1')
    .setProject('<PROJECT_ID>');

const realtime = new Realtime(client);

// Subscribe to account channel
const subscription = await realtime.subscribe(Channel.account(), response => {
    console.log(response);
});

// Subscribe to a specific row
const rowSubscription = await realtime.subscribe(
    Channel.tablesdb('<DATABASE_ID>').table('<TABLE_ID>').row('<ROW_ID>'),
    response => {
        console.log(response);
    }
);

The Channel helper supports all available channels and allows you to:

• Build channels with a fluent, chainable API
• Optionally specify resource IDs (omit IDs to subscribe to all resources)
• Add event filters like .create(), .update(), or .delete()

Available channels

A list of all channels available you can subscribe to. When using Channel helpers, leaving an ID blank will subscribe using *.

Event filters

You can also filter events by appending event methods to the channel helpers:

• .create() - Listen only to create events
• .update() - Listen only to update events
• .delete() - Listen only to delete events

For example, Channel.tablesdb('<DATABASE_ID>').table('<TABLE_ID>').row('<ROW_ID>').update() will only trigger on row updates.