> ## Documentation Index
> Fetch the complete documentation index at: https://docs.revoengine.com/llms.txt
> Use this file to discover all available pages before exploring further.

# api.publishMessage()

> Public low-code contract, signatures and examples for api.publishMessage.

## `api.publishMessage()`

Publishes a realtime message.

Notes:

* Unavailable with `readOnly: true` (throws an error).
* Currently only the 'ALL' channel is supported.

### Signature

```ts theme={null}
static publishMessage(channel: string, message: any): Promise<void>;
```

### Example

```ts theme={null}
await api.publishMessage('ALL', { state: 'started' });
```

See [all api methods](https://docs.revoengine.com/low-code/reference/api.md) or [runtime basics](https://docs.revoengine.com/low-code/overview.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.