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

zerver/webhooks/front/view.py

@@ -0,0 +1,154 @@
+from collections.abc import Callable
+
+from django.http import HttpRequest, HttpResponse
+from django.utils.translation import gettext as _
+
+from zerver.decorator import webhook_view
+from zerver.lib.exceptions import JsonableError
+from zerver.lib.response import json_success
+from zerver.lib.typed_endpoint import JsonBodyPayload, typed_endpoint
+from zerver.lib.validator import WildValue, check_string
+from zerver.lib.webhooks.common import check_send_webhook_message
+from zerver.models import UserProfile
+
+
+def get_message_data(payload: WildValue) -> tuple[str, str, str, str]:
+    link = "https://app.frontapp.com/open/" + payload["target"]["data"]["id"].tame(check_string)
+    outbox = payload["conversation"]["recipient"]["handle"].tame(check_string)
+    inbox = payload["source"]["data"][0]["address"].tame(check_string)
+    subject = payload["conversation"]["subject"].tame(check_string)
+    return link, outbox, inbox, subject
+
+
+def get_source_name(payload: WildValue) -> str:
+    type = payload["source"]["_meta"]["type"].tame(check_string)
+    if type == "teammate":
+        first_name = payload["source"]["data"]["first_name"].tame(check_string)
+        last_name = payload["source"]["data"]["last_name"].tame(check_string)
+        return f"{first_name} {last_name}"
+    elif type == "rule":
+        name = payload["source"]["data"]["name"].tame(check_string)
+        return f"'{name}' rule"
+    return f"({type})"
+
+
+def get_target_name(payload: WildValue) -> str:
+    first_name = payload["target"]["data"]["first_name"].tame(check_string)
+    last_name = payload["target"]["data"]["last_name"].tame(check_string)
+    return f"{first_name} {last_name}"
+
+
+def get_inbound_message_body(payload: WildValue) -> str:
+    link, outbox, inbox, subject = get_message_data(payload)
+    return (
+        f"[Inbound message]({link}) from **{outbox}** to **{inbox}**:\n"
+        f"```quote\n*Subject*: {subject}\n```"
+    )
+
+
+def get_outbound_message_body(payload: WildValue) -> str:
+    link, outbox, inbox, subject = get_message_data(payload)
+    return (
+        f"[Outbound message]({link}) from **{inbox}** to **{outbox}**:\n"
+        f"```quote\n*Subject*: {subject}\n```"
+    )
+
+
+def get_outbound_reply_body(payload: WildValue) -> str:
+    link, outbox, inbox, _subject = get_message_data(payload)
+    return f"[Outbound reply]({link}) from **{inbox}** to **{outbox}**."
+
+
+def get_comment_body(payload: WildValue) -> str:
+    name = get_source_name(payload)
+    comment = payload["target"]["data"]["body"].tame(check_string)
+    return f"**{name}** left a comment:\n```quote\n{comment}\n```"
+
+
+def get_conversation_assigned_body(payload: WildValue) -> str:
+    source_name = get_source_name(payload)
+    target_name = get_target_name(payload)
+
+    if source_name == target_name:
+        return f"**{source_name}** assigned themselves."
+
+    return f"**{source_name}** assigned **{target_name}**."
+
+
+def get_conversation_unassigned_body(payload: WildValue) -> str:
+    name = get_source_name(payload)
+    return f"Unassigned by **{name}**."
+
+
+def get_conversation_archived_body(payload: WildValue) -> str:
+    name = get_source_name(payload)
+    return f"Archived by **{name}**."
+
+
+def get_conversation_reopened_body(payload: WildValue) -> str:
+    name = get_source_name(payload)
+    return f"Reopened by **{name}**."
+
+
+def get_conversation_deleted_body(payload: WildValue) -> str:
+    name = get_source_name(payload)
+    return f"Deleted by **{name}**."
+
+
+def get_conversation_restored_body(payload: WildValue) -> str:
+    name = get_source_name(payload)
+    return f"Restored by **{name}**."
+
+
+def get_conversation_tagged_body(payload: WildValue) -> str:
+    name = get_source_name(payload)
+    tag = payload["target"]["data"]["name"].tame(check_string)
+    return f"**{name}** added tag **{tag}**."
+
+
+def get_conversation_untagged_body(payload: WildValue) -> str:
+    name = get_source_name(payload)
+    tag = payload["target"]["data"]["name"].tame(check_string)
+    return f"**{name}** removed tag **{tag}**."
+
+
+EVENT_FUNCTION_MAPPER = {
+    "inbound": get_inbound_message_body,
+    "outbound": get_outbound_message_body,
+    "out_reply": get_outbound_reply_body,
+    "comment": get_comment_body,
+    "mention": get_comment_body,
+    "assign": get_conversation_assigned_body,
+    "unassign": get_conversation_unassigned_body,
+    "archive": get_conversation_archived_body,
+    "reopen": get_conversation_reopened_body,
+    "trash": get_conversation_deleted_body,
+    "restore": get_conversation_restored_body,
+    "tag": get_conversation_tagged_body,
+    "untag": get_conversation_untagged_body,
+}
+
+ALL_EVENT_TYPES = list(EVENT_FUNCTION_MAPPER.keys())
+
+
+def get_body_based_on_event(event: str) -> Callable[[WildValue], str]:
+    return EVENT_FUNCTION_MAPPER[event]
+
+
+@webhook_view("Front", all_event_types=ALL_EVENT_TYPES)
+@typed_endpoint
+def api_front_webhook(
+    request: HttpRequest,
+    user_profile: UserProfile,
+    *,
+    payload: JsonBodyPayload[WildValue],
+) -> HttpResponse:
+    event = payload["type"].tame(check_string)
+    if event not in EVENT_FUNCTION_MAPPER:
+        raise JsonableError(_("Unknown webhook request"))
+
+    topic_name = payload["conversation"]["id"].tame(check_string)
+    body = get_body_based_on_event(event)(payload)
+    check_send_webhook_message(request, user_profile, topic_name, body, event)
+
+    return json_success(request)