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

zerver/webhooks/crashlytics/doc.md

@@ -0,0 +1,27 @@
+# Zulip Crashlytics integration
+
+Get notifications about Crashlytics issues in Zulip.
+
+{start_tabs}
+
+1. {!create-an-incoming-webhook.md!}
+
+1. {!generate-webhook-url-basic.md!}
+
+1. Select the app you'd like to be notified about in your
+   [Crashlytics settings panel](https://fabric.io/settings/apps).
+
+1. On the integrations subpage, select **Web Hook**, and enter the URL
+   generated above.
+
+1. Select **Verify**.
+
+{end_tabs}
+
+{!congrats.md!}
+
+![](/static/images/integrations/crashlytics/001.png)
+
+### Related documentation
+
+{!webhooks-url-specification.md!}

zerver/webhooks/crashlytics/fixtures/issue_message.json

@@ -0,0 +1,13 @@
+{
+  "event": "issue_impact_change",
+  "payload_type": "issue",
+  "payload": {
+    "display_id": 123 ,
+    "title": "Issue Title" ,
+    "method": "methodName of issue",
+    "impact_level": 2,
+    "crashes_count": 54,
+    "impacted_devices_count": 16,
+    "url": "http://crashlytics.com/full/url/to/issue"
+  }
+}

zerver/webhooks/crashlytics/fixtures/verification.json

@@ -0,0 +1,4 @@
+{
+  "event": "verification",
+  "payload_type": "none"
+}

zerver/webhooks/crashlytics/tests.py

@@ -0,0 +1,15 @@
+from zerver.lib.test_classes import WebhookTestCase
+
+
+class CrashlyticsHookTests(WebhookTestCase):
+    def test_crashlytics_verification_message(self) -> None:
+        expected_topic_name = "Setup"
+        expected_message = "Webhook has been successfully configured."
+        self.check_webhook("verification", expected_topic_name, expected_message)
+
+    def test_crashlytics_build_in_success_status(self) -> None:
+        expected_topic_name = "123: Issue Title"
+        expected_message = (
+            "[Issue](http://crashlytics.com/full/url/to/issue) impacts at least 16 device(s)."
+        )
+        self.check_webhook("issue_message", expected_topic_name, expected_message)

zerver/webhooks/crashlytics/view.py

@@ -0,0 +1,44 @@
+# Webhooks for external integrations.
+from django.http import HttpRequest, HttpResponse
+
+from zerver.decorator import webhook_view
+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
+from zerver.models import UserProfile
+
+CRASHLYTICS_TOPIC_TEMPLATE = "{display_id}: {title}"
+CRASHLYTICS_MESSAGE_TEMPLATE = "[Issue]({url}) impacts at least {impacted_devices_count} device(s)."
+
+CRASHLYTICS_SETUP_TOPIC_TEMPLATE = "Setup"
+CRASHLYTICS_SETUP_MESSAGE_TEMPLATE = "Webhook has been successfully configured."
+
+VERIFICATION_EVENT = "verification"
+
+
+@webhook_view("Crashlytics")
+@typed_endpoint
+def api_crashlytics_webhook(
+    request: HttpRequest,
+    user_profile: UserProfile,
+    *,
+    payload: JsonBodyPayload[WildValue],
+) -> HttpResponse:
+    event = payload["event"].tame(check_string)
+    if event == VERIFICATION_EVENT:
+        topic_name = CRASHLYTICS_SETUP_TOPIC_TEMPLATE
+        body = CRASHLYTICS_SETUP_MESSAGE_TEMPLATE
+    else:
+        issue_body = payload["payload"]
+        topic_name = CRASHLYTICS_TOPIC_TEMPLATE.format(
+            display_id=issue_body["display_id"].tame(check_int),
+            title=issue_body["title"].tame(check_string),
+        )
+        body = CRASHLYTICS_MESSAGE_TEMPLATE.format(
+            impacted_devices_count=issue_body["impacted_devices_count"].tame(check_int),
+            url=issue_body["url"].tame(check_string),
+        )
+
+    check_send_webhook_message(request, user_profile, topic_name, body)
+    return json_success(request)