GET /messages/{message_id}

Given a message ID, return the message object.

Additionally, a raw_content field is included. This field is useful for clients that primarily work with HTML-rendered messages but might need to occasionally fetch the message's raw Zulip-flavored Markdown (e.g. for view source or prefilling a message edit textarea).

Changes: Before Zulip 5.0 (feature level 120), this endpoint only returned the raw_content field.

Servers

Path parameters

Name Type Required Description
message_id Integer Yes

The target message's ID.

Query parameters

Name Type Required Description
allow_empty_topic_name Boolean No

Whether the client supports processing the empty string as a topic in the topic name fields in the returned data, including in returned edit_history data.

If false, the server will use the value of realm_empty_topic_display_name found in the POST /register response instead of empty string to represent the empty string topic in its response.

Changes: New in Zulip 10.0 (feature level 334). Previously, the empty string was not a valid topic.

Default value: false

apply_markdown Boolean No

If true, message content is returned in the rendered HTML format. If false, message content is returned in the raw Zulip-flavored Markdown format text that user entered.

Changes: New in Zulip 5.0 (feature level 120).

Default value: true

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.