Skip to main content
POST
/
realtime
/
v1
/
messages
Publish a batch of messages
curl --request POST \
  --url https://api.voyant.travel/realtime/v1/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "messages": [
    {
      "channel": "orders:org_123",
      "event": "order.updated",
      "data": "<unknown>"
    }
  ]
}
'
[
  {
    "id": "<string>",
    "channel": "<string>",
    "event": "<string>",
    "data": "<unknown>",
    "publishedAt": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
Authorization
string
header
required

Voyant Cloud API token, passed as Authorization: Bearer <token>. Each token carries a fixed set of scopes; an operation rejects tokens missing its required scope.

Body

application/json
​
messages
object[]
required

Up to 100 messages per request (server-enforced).

Maximum array length: 100

Response

Published messages

​
id
string
required
​
channel
string
required
​
event
string
required
​
data
any
required
​
publishedAt
string<date-time>
required