Home

Integrations

Writing webhook integrations

Interactive bots (beta)

REST API

Messages

Streams

Users

Events

Back to Home

Render message

Render a message to HTML.

POST https://omegaletter.chat/api/v1/messages/render

Usage examples

  • Python
  • JavaScript
  • curl

curl https://omegaletter.chat/api/v1/messages/render \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY \
    -d "content=**foo**"

#!/usr/bin/env python3

import zulip

# Download ~/zuliprc-dev from your dev server
client = zulip.Client(config_file="~/zuliprc-dev")

# Render a message
request = {
    'content': '**foo**'
}
result = client.render_message(request)
print(result)

More examples and documentation can be found here.

const zulip = require('zulip-js');

// Download zuliprc-dev from your dev server
const config = {
    zuliprc: 'zuliprc-dev',
};

zulip(config).then((client) => {
    // Render a message
    const params = {
        content: '**foo**',
    };

    client.messages.render(params).then(console.log);
});

Arguments

Argument Example Required Description
content **foo** Required

The content of the message.

Response

Return values

  • rendered: The rendered HTML.

Example response

A typical successful JSON response may look like:

{
    "msg": "",
    "rendered": "<p><strong>foo</strong></p>",
    "result": "success"
}