Sign in

v1

latestOpenAPI 3.0.0http://www.apache.org/licenses/LICENSE-2.0.html2026-07-14543167.2 KB
channels

Create a new thread

put/threads

Request body

textstring required

See the Rich Text page to learn more about formatting

channelIDstring uuid required
userIDstring uuid

The user that will be shown as the author of the thread. Only an admin user can be chosen. If this field is not provided, the user that created the API key will be used

embedsstring[]

An array of HTML embed codes to include in the thread. Useful for embedding media players (e.g., podcast episodes), videos, or other external content. Each embed must contain an iframe element.

createdAtstring date-time

Optional timestamp to override the default creation time for the thread. Must be in ISO 8601 format.

Example request

{
  "text": "<p>Welcome everyone!</p>",
  "embeds": [
    "<iframe src=\"https://open.spotify.com/embed/episode/...\" width=\"100%\" height=\"232\" frameBorder=\"0\"></iframe>"
  ],
  "createdAt": "2023-10-15T14:30:00.000Z"
}

Response

Successful response

idstring uuid
channelIDstring uuid

The id of the channel where this thread exists

userIDstring uuid

The id of the user that created this thread

contentstring

The content of the thread

filesstring[]

A list of URLs pointing to any file attachments on the thread

createdAtstring date-time
urlstring

A URL pointing to this thread

Example response

{
  "content": "<p>This is the thread's content</p>",
  "url": "https://app.heartbeat.chat/mycommunity/t/general/5dbcf5c9-5e7e-4285-9dab-6d3ce7f4dd1e",
  "comments": [
    {
      "content": "<p>This is the comments's content</p>",
      "children": [
        {
          "content": "<p>This is the comments's content</p>"
        }
      ]
    }
  ]
}