List Thread Messages
twake.list_messages
ActionChat & messagingconnection required
Calls the Twake API with the connection's credentials.
Read a page of the messages in a thread, newest first by default.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Twake
- Secret shape
- {"app_id": "…", "app_secret": "…"} — the application's API settings
- Config it needs
- base_url, company_id, workspace_id
- Resolved by
- config.connection_id, else node.connection_id
Configuration
6 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
thread_id The thread to act on; twake.send_message returns it as 'id'. | string | Yes | — | — | 7f1c9a20-0000-1111-2222-333344445555 |
limit How many records to return in one page. | number | No | 50 | ≥ 1 | — |
page_token Continuation token from a previous call's next_page_token; blank starts at the first page. | string | No | — | — | — |
direction Which way to walk the thread: 'history' goes back in time, 'future' forward. | string | No | history | one of "history", "future" | — |
include_users Include the sending user's profile alongside each message. | boolean | No | false | — | — |
company_id Twake company to act in; overrides the company set on the connection. | string | No | — | — | a1b2c3d4-1111-2222-3333-444455556666 |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"company_id": "a1b2c3d4-1111-2222-3333-444455556666",
"direction": "history",
"include_users": false,
"limit": 50,
"thread_id": "7f1c9a20-0000-1111-2222-333344445555"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
items The records this page carried. | array | — |
count How many records this page carried. | number | — |
next_page_token Token for the next page, empty when this was the last. | string | — |
thread_id The thread the messages were read from. | string | — |
{
"count": 0,
"items": [],
"next_page_token": "",
"thread_id": ""
}See List Thread Messages run in a workflow.
In a technical demo we add the Twake connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.