ROroblox
Universes

Publish Universe Message

Publishes a message to the universe's live servers.

Servers can consume messages via MessagingService.

post/cloud/v2/universes/{universe_id}:publishMessage

Request

  • Base URL
    https://apis.roblox.com
  • URL
    https://apis.roblox.com/cloud/v2/universes/{universe_id}:publishMessage
  • Auth
    • API key in header x-api-key
    • or OAuth 2
      Authorization code: https://apis.roblox.com/oauth/v1/authorize
      Token URL: https://apis.roblox.com/oauth/v1/token

Path parameters

universe_idstring required

The universe ID.

Request body

topicstring required

The topic on which to publish the message.

messagestring required

The message to publish.

Example request

{
  "topic": "my-topic",
  "message": "Hello, world!"
}

Response

OK

Changes

No recorded changes to this operation across all 33 revisions of this API.