Skip to main content
GET
/
api
/
realtime
/
channels
List All Channels
curl --request GET \
  --url https://api.example.com/api/realtime/channels \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "pattern": "order:*",
    "description": "Order updates channel",
    "webhookUrls": [
      "https://example.com/webhook"
    ],
    "enabled": true,
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-15T10:30:00Z"
  },
  {
    "id": "550e8400-e29b-41d4-a716-446655440001",
    "pattern": "chat:*",
    "description": "Chat room messages",
    "webhookUrls": null,
    "enabled": true,
    "createdAt": "2024-01-16T11:00:00Z",
    "updatedAt": "2024-01-16T11:00:00Z"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

List of channels

​
id
string<uuid>
required

Unique identifier for the channel

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
pattern
string
required

Channel pattern for subscription matching (supports wildcards like "order:*")

Minimum string length: 1
Example:

"order:*"

​
enabled
boolean
required

Whether the channel is currently active

Example:

true

​
createdAt
string<date-time>
required

Timestamp when the channel was created

Example:

"2024-01-15T10:30:00Z"

​
updatedAt
string<date-time>
required

Timestamp when the channel was last updated

Example:

"2024-01-15T10:30:00Z"

​
description
string | null

Human-readable description of the channel

Example:

"Order updates channel"

​
webhookUrls
string<uri>[] | null

URLs to receive webhook notifications for messages on this channel

Example:
["https://example.com/webhook"]