Book a demo

Get Message

zulip.get_message
ActionChat & messagingconnection required

Calls the Zulip API with the connection's credentials.

Read one message by id, with its raw Markdown alongside.

Ask about ZulipAll Zulip nodesProvider API docs ↗

Connection

Required
Yes — the node will not save without one
Auth type
Username & password
Providers
Zulip
Secret shape
{"email": "…", "api_key": "…"} — HTTP Basic, email as the username
Config it needs
base_url
Resolved by
config.connection_id, else node.connection_id

Configuration

2 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.

FieldTypeRequiredDefaultConstraintsExample
message_id
The message to act on, as returned by zulip.send_message or zulip.get_messages.
stringYes——42
apply_markdown
Return message content as rendered HTML; switch it off to get the raw Markdown.
booleanNotrue——

Example configuration

Every value below is the contract’s own example or default — nothing invented.

{
  "apply_markdown": true,
  "message_id": "42"
}

Output

One shape.

result

FieldTypeExample
message.id
The message id.
number—
message.content
The message body, rendered or raw per apply_markdown.
string—
message.sender_id
User id of whoever sent the message.
number—
message.sender_email
Email address of the sender.
string—
message.sender_full_name
Display name of the sender.
string—
message.type
Either 'stream' for a channel message or 'private' for a direct one.
string—
message.stream_id
The channel the message was sent to, for a channel message.
number—
message.subject
The topic of a channel message.
string—
message.timestamp
When the message was sent, as a Unix timestamp.
number—
message.reactions
Reactions on the message.
array—
message.flags
The current user's flags on the message, such as 'read'.
array—
raw_content
The message's raw Markdown source.
string—
result
Zulip's result field.
string—
{
  "message": {
    "content": "",
    "flags": [],
    "id": 0,
    "reactions": [],
    "sender_email": "",
    "sender_full_name": "",
    "sender_id": 0,
    "stream_id": 0,
    "subject": "",
    "timestamp": 0,
    "type": ""
  },
  "raw_content": "",
  "result": ""
}

Related Zulip nodes

See Get Message run in a workflow.

In a technical demo we add the Zulip connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.

Book a technical demoTalk to sales