v1

latestOpenAPI 3.0.32026-07-26172157253.6 KB

Messages

List Messages

Retrieve message history with optional filters

get/api/realtime/messages

Query parameters

channelIdstring uuid

Filter messages by channel ID

eventNamestring

Filter messages by event name

limitinteger

Maximum number of messages to return

offsetinteger

Number of messages to skip

Response

List of messages

idstring uuid required

Unique identifier for the message

eventNamestring required

Name of the event

channelIdstring uuid nullable

ID of the channel this message belongs to

channelNamestring required

Resolved channel name (instance of the pattern)

payloadobject required

Message payload data

senderType'system' | 'user' required

Type of sender that published the message

senderIdstring uuid nullable

ID of the user who sent the message (null for system messages)

wsAudienceCountinteger required

Number of WebSocket clients who received the message

whAudienceCountinteger required

Number of webhooks that should receive the message

whDeliveredCountinteger required

Number of webhooks that successfully received the message

createdAtstring date-time required

Timestamp when the message was created

Example response

[
  {
    "id": "660e8400-e29b-41d4-a716-446655440000",
    "eventName": "order.created",
    "channelId": "550e8400-e29b-41d4-a716-446655440000",
    "channelName": "order:123",
    "payload": {
      "orderId": "123",
      "status": "pending"
    },
    "senderType": "user",
    "senderId": "770e8400-e29b-41d4-a716-446655440000",
    "wsAudienceCount": 5,
    "whAudienceCount": 1,
    "whDeliveredCount": 1,
    "createdAt": "2024-01-15T10:30:00Z"
  }
]