List Messages
webex.list_messages
ActionChat & messagingconnection required
Calls the Cisco Webex API with the connection's credentials.
List messages in a space or a 1:1 room, newest first.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Bearer token
- Providers
- Cisco Webex
- Secret shape
- the Webex access token, or {"access_token": "…"}
- Resolved by
- config.connection_id, else node.connection_id
Configuration
8 fields, none 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 |
|---|---|---|---|---|---|
room_id Id of the space to read. Leave blank and set person_email to read a 1:1 room. | string | No | — | — | Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0 |
person_email Read the 1:1 room with this person instead of a space. | string | No | — | email format | john.andersen@example.com |
person_id Read the 1:1 room with this person id instead of a space. | string | No | — | — | — |
parent_id Only the replies in this message's thread. | string | No | — | — | — |
mentioned_people Only messages mentioning this person: 'me', or a person id. | string | No | — | — | — |
before Only messages sent before this ISO-8601 date and time. | string | No | — | iso8601 format | — |
before_message Only messages sent before this message id. | string | No | — | — | — |
max_results How many messages to ask for. Webex caps it at 100 when mentioned_people is set. | number | No | 50 | ≥ 1 | — |
- At least one of room_id, person_email, person_id must be set.
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"max_results": 50,
"person_email": "john.andersen@example.com",
"room_id": "Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
items[].id The message id — pass it to webex.get_message or delete_message. | string | — |
items[].room_id Id of the space the message is in. | string | — |
items[].room_type 'group' for a space, 'direct' for a 1:1 room. | string | — |
items[].parent_id Id of the parent message when this is a threaded reply. | string | — |
items[].person_id Id of the person or bot that posted it. | string | — |
items[].person_email Email of the person or bot that posted it. | string | — |
items[].text The message as plain text. | string | — |
items[].markdown The message as Markdown, when it was sent that way. | string | — |
items[].html The HTML Webex rendered from the Markdown. | string | — |
items[].files URLs of the attachments; downloading one needs the same access token. | array | — |
items[].created When the message was posted (ISO-8601). | string | — |
items[].updated When it was last edited, if it has been. | string | — |
count How many rows this page carries. | number | — |
{
"count": 0,
"items": [
{
"created": "",
"files": [],
"html": "",
"id": "",
"markdown": "",
"parent_id": "",
"person_email": "",
"person_id": "",
"room_id": "",
"room_type": "",
"text": "",
"updated": ""
}
]
}Notes
- The connection's token is the actor: a bot token only sees the spaces the bot has been added to, and a personal or integration token acts as that user.
- A space and a 1:1 room are different endpoints: room_id reads a space, person_email or person_id reads the direct room with that person.
- One page only: Webex paginates with an RFC 5988 Link header, which this node does not follow — narrow the filters or raise max_results instead.
See List Messages run in a workflow.
In a technical demo we add the Cisco Webex connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.