---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Realtime messages"
description: "The `realtime_messages` collection of Sylphx Events: A Realtime Message is one message in a channel's ordered history, kept for the channel's `history_retention`."
type: reference
product: realtime
summary: "A Realtime Message is one message in a channel's ordered history, kept for the channel's `history_retention`."
updated: 2026-09-28
order: 900
---

A Realtime Message is one message in a channel's ordered history, kept for the channel's `history_retention`.

**Service** Sylphx Events · **Resource type** `events.sylphx.com/RealtimeMessage` · **Name pattern** `orgs/{org}/projects/{project}/envs/{env}/realtime_channels/{realtime_channel}/realtime_messages/{realtime_message}` · **Shape** `record`

## Fields

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `…/realtime_channels/{realtime_channel}/realtime_messages/{realtime_message}`. |
| `uid` | `string` | `rtm_<cell><ulid>`; never reused. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `cursor` | `string` | The message's place in the channel; send it back as `after_cursor` (or `Last-Event-ID`) to resume after it. Output only. |
| `sequence` | `int64` | The position in the channel, from 1, gap-free. Output only. |
| `message_type` | `string` | The message name (`chat.message`, `presence.enter`, …). Required. |
| `data` | `value` | The payload. |
| `client_id` | `string` | The publisher's client id, when it named one. |
| `publish_time` | `timestamp` | When the channel appended it. Output only. |

## Methods

Every method of the collection, in the registry's order, with the scope it
needs. The full request, response and examples are one link away.

| Method | Call | What it does |
| --- | --- | --- |
| `GET` | [`get`](/docs/api/realtime_messages#get) | Gets one retained message of a channel. |
| `GET` | [`list`](/docs/api/realtime_messages#list) | Lists a channel's retained messages, oldest first. |

## get

Gets one retained message of a channel.

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel/realtime_messages/realtime-message` · scope `events:read` · effect `read` · [Request, response and examples](/docs/api/realtime_messages/get)

## list

Lists a channel's retained messages, oldest first.

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel/realtime_messages` · scope `events:read` · effect `read` · paginated · [Request, response and examples](/docs/api/realtime_messages/list)