Looks like it’s mainly just expecting too much from the introduction page, specifically I was looking at this:
Receiving messages
Clients that have listened on a set of topics will receive message streams to those topics.
Message Parameters
Name Type Description
type string Set to 'MESSAGE'.
data JSON Wraps the `topic` and `message` fields.
topic string The topic the message is being sent on.
message string The body of the message.
Example message
{
"type": "MESSAGE",
"data": {
"topic": "video-playback.lirik",
"message": "..."
}
}
When really I was expecting something more like this in the “message”: “…” section
Receiving a Bits event message
When a message for your subscription is published, you will receive a message containing the applicable data. The message will look like the following:
{
"type": "MESSAGE",
"data": {
"topic": "channel-bitsevents.XXXXXXXX",
"message": {
"user_name": "dallasnchains",
"channel_name": "twitch",
"user_id": "...",
"channel_id": "...",
"time": "2015-12-19T16:39:57-08:00",
"chat_message": "Omg that baneling bust was Kreygasm cheer10 cheer10 cheer100",
"bits_used": 120,
"total_bits_used": 620,
"context": "cheer"
}
}
}
(The bits example is perfect for the message)
Specifically, since you’re requesting the topic "topic": "video-playback.lirik" I am looking for the message data response for ‘video-playback.lirik’. This could be a bad expectation on my part, it just seems like a confusing example when you’re reading about it as an introduction page.
Though the confusion would go the other way, with a provided example body someone might assume that’s the only message type you can receive from that endpoint… so idk.
Maybe the easiest solution is to just mention somewhere in text ‘message format comes from the specified topic, please refer to the topic endpoint documentation.’’?