Skip to main content

Send a Roam message

POST 
/chat.sendMessage

Sends the given message to the specified recipients. At this time, we only support sending to a single group recipient. You can obtain the group ID on the "Group Settings" page. That means recipients will always be a single-element array containing a single UUIDv4.

The sender JSON object contains three (optional) string fields: id, name, and imageUrl. The id is an internal name of the bot you wish to send as, name is the user-visible bot name (that is seen when viewing groups), and imageUrl is the image URL of the bot. Generally, you only need to specify id and name (e.g. datadog as id and Datadog Alerts as name). If omitted, the ID and sender are inferred to be the API client name.

Message Text Format​

At this time, we do not fully support standard Markdown, but support is forthcoming. To indicate a line break, you must use TWO new line characters in the message (e.g.. \n\n).

Access: Organization only.

Required scope: chat:send_message

OpenAPI Spec: openapi.json

Request​

Responses​

Message successfully sent