Messaging Service

This page contains reference documentation for the Open Cloud v1 Messaging Service API, which can broadcast messages across all servers in your experience.

The v2 API has its own version of the Publish Message method. For information on using the v2 method, see the Messaging usage guide.

CrossServerMessaging

https://apis.roblox.com/messaging-service/
The following endpoints are available at paths relative to the base URL.

Publish a Message

POST /v1/universes/{universeId}/topics/{topic}

Publish a message to a pre-defined topic of an experience, with the size of the message up to 1,024 characters (1 KB). Requires the Publish permission for API keys and the universe-messaging-service:publish scope for OAuth 2.0 apps. See Cross-server messaging for defining and subscribing users to a topic.

Parameters

universeId number

The identifier of the experience in which you want to send your messages to. You can copy your experience's Universe ID on Creator Dashboard.

Path
Required
topic string

The topic that you want to publish your message to, with up to 80 characters.

Path
Required

Response

Required Permissions

The following API key permissions are required to call this endpoint. For more information on generating proper keys, see Manage API keys.

  • Publish

The following scopes are required for your OAuth 2.0 application to use this endpoint. For more information on how to register an OAuth 2.0 application, see App registration and review.

  • universe-messaging-service:publish

Objects

The following objects describe payloads that are accepted or returned. See each individual endpoint for more information on when these objects are used.

PublishRequest

The request body object with the message string that you want to publish to the live server.

Attributes

message string

The message content that you want to publish to the live server.