v1

latestOpenAPI 3.0.32026-07-26172157253.6 KB

Channels

List All Channels

Retrieve all configured realtime channels

get/api/realtime/channels

Response

List of channels

idstring uuid required

Unique identifier for the channel

patternstring required

Channel pattern for subscription matching. Uses SQL LIKE wildcards, for example "order:%".

descriptionstring nullable

Human-readable description of the channel

webhookUrlsstring[] nullable

URLs to receive webhook notifications for messages on this channel

enabledboolean required

Whether the channel is currently active

createdAtstring date-time required

Timestamp when the channel was created

updatedAtstring date-time required

Timestamp when the channel was last updated

Example response

[
  {
    "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"
  }
]