Add zulip as a notification provider

[Rems08]

⚠️ Please verify that this feature request has NOT been suggested before.

• [X] I checked and didn't find similar feature request

🏷️ Feature Request Type

New Notification

🔖 Feature description

I would like to send a detailed notification from my kuma-uptime to my self-hosted zulip server. That's why I can't use aprise (enterprise proxy)

✔️ Solution

If you could create a native zulip notification that would be great!

❓ Alternatives

No response

📝 Additional Context

No response

[tplecko]

I have written a simple webhook that resides on the same machine as Uptime Kuma, and just reposts the data in zulip format as a message to a stream. Also, this way, if the status is a failure, I can tag people and groups.

[tplecko]

<?php 
$data = json_decode(file_get_contents('php://input'), true);
$content = 
"| Name | Hostname |\n".
"|---|---|\n".
"| ".$data['monitor']['name']." | ".$data['monitor']['hostname']." |\n\n".
"| Message |\n".
"|---|\n".
"| ".$data['msg']." |\n";

$payload = array (
    'type'        => 'stream',
    'to'          => 'infrastructure',
    'subject'     => $data['monitor']['name'],
    'content'     => $content
);

$ch = curl_init('https://<zulip-url>/api/v1/messages');
curl_setopt($ch, CURLOPT_USERPWD, '<bot-name>:<bot-password>');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $payload);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_exec($ch);
?>

One simple if ($data['heartbeat']['status']=='0') will allow you to customize the message (you don't have to pass the data from Uptime Kuma to Zulip as-is

Also, make sure that content type is application/json.

[AdamJSoftware]

Containerized it https://hub.docker.com/repository/docker/databending/kuma-to-zulip

[eXtrem0us]

Hey Guys -On the Uptime Kuma side, We used Slack as Notification Type (don't fill the Channel Name field!) -On the Zulip side, we used Slack too. Just check the Zulip Integration for Slack documents.

This works for us and fulfills our needs. However there are some small downsides of this workaround. Uptime Kuma sends some special characters to Zulip that makes some rectangles appear above the alert messages, instead of creating proper tables. I couldn't find the section of code that generates these pipes "|" and dashes "-". (In this case, this issue may be relevant)

The other issue is that we can not specify the topic name besides stream name in the Webhook URL section. This is the Zulip webhook URL template: https://[Zulip Hostname]/api/v1/external/slack_incoming?api_key=[Robot API Key]&stream=UpTime-Kuma&topic=[Monitor Name]. I couldn't find documents that tell us how to make the Webhook URL dynamic.

[eXtrem0us]

Eventually, I wrote a Logstash config, which

• gets the UptimeKuma webhook and
• convert it to UptimeRobot webhook... and
• then it sends the evolved webhook to Zulip:

Logstash config

```logstash input { http { id => "uptimekuma-log" port => 10221 codec => json { charset => "UTF-8" } } } filter { mutate { add_field => { "monitor_url" => "%{[monitor][url]}" "monitor_friendly_name" => "%{[monitor][name]}" "alert_type" => "%{[heartbeat][status]}" "alert_details" => "%{[msg]}" "alert_friendly_duration" => "" } } if [heartbeat][status] == 0 { mutate { add_field => { "alert_type_friendly_name" => "Down" } } } else { mutate { add_field => { "alert_type_friendly_name" => "Up" } } } ruby { code => ' seconds = event.get("[heartbeat][duration]").to_i minutes = seconds / 60 seconds %= 60 hours = minutes / 60 minutes %= 60 event.set("alert_friendly_duration", "#{hours} hour(s), #{minutes} minute(s) and #{seconds} second(s)") ' } mutate { remove_field => ["headers", "monitor", "heartbeat", "msg", "@version", "@timestamp", "host"] } } output { http { url => "https://zulip.myhostname.com/api/v1/external/uptimerobot?api_key=abcdefghijklmnopqr&stream=Uptime-Kuma&" http_method => "post" format => "json" mapping => { "monitor_url" => "%{monitor_url}" "monitor_friendly_name" => "%{monitor_friendly_name}" "alert_type" => "%{alert_type}" "alert_type_friendly_name" => "%{alert_type_friendly_name}" "alert_details" => "%{alert_details}" "alert_friendly_duration" => "%{alert_friendly_duration}" } } } ```

[alexmv]

Uptime Kuma sends some special characters to Zulip that makes some rectangles appear above the alert messages, instead of creating proper tables.

See zulip/zulip@1b692984cefcd15421a1edac835278a6c91c08d7 -- specifically, Zulip's markdown syntax requires a header row at the top of a table. Since Slack's "fields" concept does not have headers, merely rendering every field in a 2-wide table left-to-right-top-to-bottom, we chose to insert an empty "header" row, resulting in the black bar, and then insert the provided content into the "body" of the two-wide table.

If you want to improve this rendering for Uptime Kuma messages your options are:

• Submit a PR to Zulip to add a custom integration endpoint. This means Uptime Kuma would submit whatever JSON structure it wants, and the Zulip server would be responsible for how to render that to Markdown to send it as a message; it can also have internal logic for what topic to send to.
• Use our API to send the message from the Uptime Kuma server, as above (https://github.com/louislam/uptime-kuma/issues/1052#issuecomment-1056845350). All of the formatting and logic about where to send is on the calling server's side.

See https://zulip.com/api/incoming-webhooks-overview for a discussion of both of these options.