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

zerver/webhooks/appfollow/doc.md

@@ -0,0 +1,27 @@
+# Zulip AppFollow integration
+
+Receive user reviews from your tracked apps on AppFollow!
+
+{start_tabs}
+
+1. {!create-an-incoming-webhook.md!}
+
+1. {!generate-webhook-url-basic.md!}
+
+1. In AppFollow, go to **Integrations**, and select **Add new
+   integration**. Select your app under **Tracked apps**.
+
+1. Search for **WebHook URL**, and click **Add integration**.
+
+1. Set **WebHook URL** to the URL generated above, and fill out the rest
+   of the form. Click **Add integration**.
+
+{end_tabs}
+
+{!congrats.md!}
+
+![](/static/images/integrations/appfollow/001.png)
+
+### Related documentation
+
+{!webhooks-url-specification.md!}

zerver/webhooks/appfollow/fixtures/review.json

@@ -0,0 +1,3 @@
+{
+  "text":"Acme - Group chat\nApp Store, Acme Technologies, Inc.\n★★★★★ United States\n*Great for Information Management*\nAcme enables me to manage the flow of information quite well. I only wish I could create and edit my Acme Post files in the iOS app.\n_by_ *Mr RESOLUTIONARY* _for v3.9_\n[Permalink](http:\/\/appfollow.io\/permalink) · [Add tag](http:\/\/watch.appfollow.io\/add_tag)"
+}

zerver/webhooks/appfollow/fixtures/sample.json

@@ -0,0 +1,3 @@
+{
+  "text":"Webhook integration was successful.\nTest User \/ Acme (Google Play)"
+}

zerver/webhooks/appfollow/tests.py

@@ -0,0 +1,60 @@
+from zerver.lib.test_classes import WebhookTestCase, ZulipTestCase
+from zerver.webhooks.appfollow.view import convert_markdown
+
+
+class AppFollowHookTests(WebhookTestCase):
+    def test_sample(self) -> None:
+        expected_topic_name = "Webhook integration was successful."
+        expected_message = """Webhook integration was successful.
+Test User / Acme (Google Play)"""
+        self.check_webhook(
+            "sample",
+            expected_topic_name,
+            expected_message,
+            content_type="application/x-www-form-urlencoded",
+        )
+
+    def test_reviews(self) -> None:
+        expected_topic_name = "Acme - Group chat"
+        expected_message = """Acme - Group chat
+App Store, Acme Technologies, Inc.
+★★★★★ United States
+**Great for Information Management**
+Acme enables me to manage the flow of information quite well. I only wish I could create and edit my Acme Post files in the iOS app.
+*by* **Mr RESOLUTIONARY** *for v3.9*
+[Permalink](http://appfollow.io/permalink) · [Add tag](http://watch.appfollow.io/add_tag)"""
+        self.check_webhook(
+            "review",
+            expected_topic_name,
+            expected_message,
+            content_type="application/x-www-form-urlencoded",
+        )
+
+    def test_reviews_with_topic(self) -> None:
+        self.url = self.build_webhook_url() + "&topic=foo"
+        expected_topic_name = "foo"
+        expected_message = """Acme - Group chat
+App Store, Acme Technologies, Inc.
+★★★★★ United States
+**Great for Information Management**
+Acme enables me to manage the flow of information quite well. I only wish I could create and edit my Acme Post files in the iOS app.
+*by* **Mr RESOLUTIONARY** *for v3.9*
+[Permalink](http://appfollow.io/permalink) · [Add tag](http://watch.appfollow.io/add_tag)"""
+        self.check_webhook(
+            "review",
+            expected_topic_name,
+            expected_message,
+            content_type="application/x-www-form-urlencoded",
+        )
+
+
+class ConvertMarkdownTest(ZulipTestCase):
+    def test_convert_bold(self) -> None:
+        self.assertEqual(convert_markdown("*test message*"), "**test message**")
+
+    def test_convert_italics(self) -> None:
+        self.assertEqual(convert_markdown("_test message_"), "*test message*")
+        self.assertEqual(convert_markdown("_  spaced message _"), "  *spaced message* ")
+
+    def test_convert_strikethrough(self) -> None:
+        self.assertEqual(convert_markdown("~test message~"), "~~test message~~")

zerver/webhooks/appfollow/view.py

@@ -0,0 +1,43 @@
+# Webhooks for external integrations.
+import re
+
+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_string
+from zerver.lib.webhooks.common import check_send_webhook_message
+from zerver.models import UserProfile
+
+
+@webhook_view("AppFollow")
+@typed_endpoint
+def api_appfollow_webhook(
+    request: HttpRequest,
+    user_profile: UserProfile,
+    *,
+    payload: JsonBodyPayload[WildValue],
+) -> HttpResponse:
+    message = payload["text"].tame(check_string)
+    app_name_search = re.search(r"\A(.+)", message)
+    assert app_name_search is not None
+    app_name = app_name_search.group(0)
+    topic_name = app_name
+
+    check_send_webhook_message(request, user_profile, topic_name, body=convert_markdown(message))
+    return json_success(request)
+
+
+def convert_markdown(text: str) -> str:
+    # Converts Slack-style Markdown to Zulip format
+    # Implemented mainly for AppFollow messages
+    # Not ready for general use as some edge-cases not handled
+    # Convert bold
+    text = re.sub(r"(?:(?<=\s)|(?<=^))\*(.+?\S)\*(?=\s|$)", r"**\1**", text)
+    # Convert italics
+    text = re.sub(r"\b_(\s*)(.+?)(\s*)_\b", r"\1*\2*\3", text)
+    # Convert strikethrough
+    text = re.sub(r"(?:(?<=\s)|(?<=^))~(.+?\S)~(?=\s|$)", r"~~\1~~", text)
+
+    return text