Skip to content

Realtime

realtime_messages_publish

Publish a JSON message to a realtime channel of the current product

Tool

realtime_messages_publish

Publish a JSON message to a realtime channel of the current product

Publish a JSON message to a realtime channel of the current product

Behavior

HTTP
POST /realtime/messages

Arguments

NameTypeRequiredDescription
datastringJSON payload delivered to channel subscribers
channelstringChannel to publish the message to

Response

FieldTypeAlwaysDescription
epochstringStream epoch of the stored message (present when history is on)
offsetstringStream offset of the stored message (present when history is on)
channelstringChannel the message was published to
publishedbooleanPublish acknowledged by the fan-out backend

Try it

Publish a JSON message to a realtime channel of the current product.

When to use

Publish a JSON message to a realtime channel of the current product

Example

Ask your agent something like this:

Publish a JSON message to a realtime channel of the current product.

The agent will invoke realtime_messages_publish with these arguments:

{
  "data": "<data>",
  "channel": "<channel>"
}

Esc

Start typing to search the docs.

navigateselect