snapshot of https://github.com/zulip/zulip.git @ 48c69911c7dd4e03b20552eb3bd77ad8151c1357 (2026-09-15)

zerver/webhooks/freshping/view.py

@@ -0,0 +1,73 @@
+from django.http import HttpRequest, HttpResponse
+
+from zerver.decorator import webhook_view
+from zerver.lib.exceptions import UnsupportedWebhookEventTypeError
+from zerver.lib.response import json_success
+from zerver.lib.typed_endpoint import JsonBodyPayload, typed_endpoint
+from zerver.lib.validator import WildValue, check_int, check_string
+from zerver.lib.webhooks.common import check_send_webhook_message, get_setup_webhook_message
+from zerver.models import UserProfile
+
+FRESHPING_TOPIC_TEMPLATE_TEST = "Freshping"
+FRESHPING_TOPIC_TEMPLATE = "{check_name}"
+
+FRESHPING_MESSAGE_TEMPLATE_UNREACHABLE = """
+{request_url} has just become unreachable.
+Error code: {http_status_code}.
+""".strip()
+FRESHPING_MESSAGE_TEMPLATE_UP = "{request_url} is back up and no longer unreachable."
+CHECK_STATE_NAME_TO_EVENT_TYPE = {"Reporting Error": "reporting_error", "Available": "available"}
+ALL_EVENT_TYPES = list(CHECK_STATE_NAME_TO_EVENT_TYPE.values())
+
+
+@webhook_view("Freshping", all_event_types=ALL_EVENT_TYPES)
+@typed_endpoint
+def api_freshping_webhook(
+    request: HttpRequest,
+    user_profile: UserProfile,
+    *,
+    payload: JsonBodyPayload[WildValue],
+) -> HttpResponse:
+    check_state_name = payload["webhook_event_data"]["check_state_name"].tame(check_string)
+    if check_state_name not in CHECK_STATE_NAME_TO_EVENT_TYPE:
+        raise UnsupportedWebhookEventTypeError(check_state_name)
+    body = get_body_for_http_request(payload)
+    topic_name = get_topic_for_http_request(payload)
+
+    check_send_webhook_message(
+        request,
+        user_profile,
+        topic_name,
+        body,
+        CHECK_STATE_NAME_TO_EVENT_TYPE[check_state_name],
+    )
+    return json_success(request)
+
+
+def get_topic_for_http_request(payload: WildValue) -> str:
+    webhook_event_data = payload["webhook_event_data"]
+    if webhook_event_data["application_name"].tame(check_string) == "Webhook test":
+        topic_name = FRESHPING_TOPIC_TEMPLATE_TEST
+    else:
+        topic_name = FRESHPING_TOPIC_TEMPLATE.format(
+            check_name=webhook_event_data["check_name"].tame(check_string)
+        )
+    return topic_name
+
+
+def get_body_for_http_request(payload: WildValue) -> str:
+    webhook_event_data = payload["webhook_event_data"]
+    if webhook_event_data["check_state_name"].tame(check_string) == "Reporting Error":
+        body = FRESHPING_MESSAGE_TEMPLATE_UNREACHABLE.format(
+            request_url=webhook_event_data["request_url"].tame(check_string),
+            http_status_code=webhook_event_data["http_status_code"].tame(check_int),
+        )
+    elif webhook_event_data["check_state_name"].tame(check_string) == "Available":
+        if webhook_event_data["application_name"].tame(check_string) == "Webhook test":
+            body = get_setup_webhook_message("Freshping")
+        else:
+            body = FRESHPING_MESSAGE_TEMPLATE_UP.format(
+                request_url=webhook_event_data["request_url"].tame(check_string)
+            )
+
+    return body