Skip to main content
GET
List Messages

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

channelId
string<uuid>

Filter messages by channel ID

eventName
string

Filter messages by event name

limit
integer
default:100

Maximum number of messages to return

Required range: 1 <= x <= 1000
offset
integer
default:0

Number of messages to skip

Required range: x >= 0

Response

List of messages

id
string<uuid>
required

Unique identifier for the message

Example:

"660e8400-e29b-41d4-a716-446655440000"

eventName
string
required

Name of the event

Minimum string length: 1
Example:

"order.created"

channelName
string
required

Resolved channel name (instance of the pattern)

Minimum string length: 1
Example:

"order:123"

payload
object
required

Message payload data

Example:
senderType
enum<string>
required

Type of sender that published the message

Available options:
system,
user
Example:

"user"

wsAudienceCount
integer
required

Number of WebSocket clients who received the message

Required range: x >= 0
Example:

5

whAudienceCount
integer
required

Number of webhooks that should receive the message

Required range: x >= 0
Example:

1

whDeliveredCount
integer
required

Number of webhooks that successfully received the message

Required range: x >= 0
Example:

1

createdAt
string<date-time>
required

Timestamp when the message was created

Example:

"2024-01-15T10:30:00Z"

channelId
string<uuid> | null

ID of the channel this message belongs to

Example:

"550e8400-e29b-41d4-a716-446655440000"

senderId
string<uuid> | null

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

Example:

"770e8400-e29b-41d4-a716-446655440000"