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

zerver/webhooks/zapier/doc.md

@@ -0,0 +1,47 @@
+# Zulip Zapier integration
+
+Zapier supports integrations with
+[hundreds of popular products](https://zapier.com/apps). Get notifications
+sent by Zapier directly in Zulip.
+
+{start_tabs}
+
+1. {!create-channel.md!}
+
+1. {!create-an-incoming-webhook.md!}
+
+1. Create an account on [Zapier](https://zapier.com). Go to [Zulip
+   Integrations][1], and select the app you want to connect to Zulip.
+
+1. Under **Choose a Trigger**, select an event in the app you are
+   connecting to Zulip. Under **Choose an Action**, select **Send a
+   Private Message** or **Send a Stream Message**. Click **Connect**.
+
+1. Follow the instructions in the right sidebar to set up the trigger
+   event.
+
+1. Select the Zulip action in the center panel, and under **Account** in
+   the right sidebar, click **Sign in** to connect your bot to Zapier.
+
+1. On the **Allow Zapier to access your Zulip Account** screen, enter
+   the URL for your Zulip organization, and the email address and API
+   key of the bot you created above.
+
+1. Under **Action** in the right sidebar, configure **Recipients** for
+   direct messages, or **Stream name** and **Topic** for channel
+   messages. Configure **Message content**.
+
+    !!! tip ""
+        To receive notifications as direct messages, if your email
+        in Zulip is [configured](/help/configure-email-visibility)
+        to be visible to **Admins, moderators, members and guests**,
+        enter the email associated with your Zulip account in the
+        **Recipients** field. Otherwise, enter `user` +
+        [your user ID](/help/view-someones-profile) +
+        `@` + your Zulip domain, e.g., `user123@{{ display_host }}`.
+
+1. Click **Publish** to enable your Zap.
+
+{end_tabs}
+
+[1]: https://zapier.com/apps/zulip/integrations

zerver/webhooks/zapier/fixtures/correct_subject_and_body.json

@@ -0,0 +1,4 @@
+{
+  "content": "Your email content is: \nMy Email content.\n",
+  "subject": "New email from zulip@zulip.com"
+}

zerver/webhooks/zapier/fixtures/correct_topic_and_body.json

@@ -0,0 +1,4 @@
+{
+  "content": "Your email content is: \nMy Email content.\n",
+  "topic": "New email from zulip@zulip.com"
+}

zerver/webhooks/zapier/fixtures/weather_update.json

@@ -0,0 +1,4 @@
+{
+  "content": "Foggy in the morning.\nMaximum temperature to be 24.\nMinimum temperature to be 12",
+  "subject": "Here is your weather update for the day:"
+}

zerver/webhooks/zapier/fixtures/zapier_zulip_app_auth.json

@@ -0,0 +1,3 @@
+{
+    "type": "auth"
+}

zerver/webhooks/zapier/tests.py

@@ -0,0 +1,30 @@
+from zerver.lib.test_classes import WebhookTestCase
+
+
+class ZapierHookTests(WebhookTestCase):
+    def test_zapier_when_subject_and_body_are_correct(self) -> None:
+        expected_topic_name = "New email from zulip@zulip.com"
+        expected_message = "Your email content is: \nMy Email content."
+        self.check_webhook("correct_subject_and_body", expected_topic_name, expected_message)
+
+    def test_zapier_when_topic_and_body_are_correct(self) -> None:
+        expected_topic_name = "New email from zulip@zulip.com"
+        expected_message = "Your email content is: \nMy Email content."
+        self.check_webhook("correct_topic_and_body", expected_topic_name, expected_message)
+
+    def test_zapier_weather_update(self) -> None:
+        expected_topic_name = "Here is your weather update for the day:"
+        expected_message = (
+            "Foggy in the morning.\nMaximum temperature to be 24.\nMinimum temperature to be 12"
+        )
+        self.check_webhook("weather_update", expected_topic_name, expected_message)
+
+
+class ZapierZulipAppTests(WebhookTestCase):
+    def test_auth(self) -> None:
+        payload = self.get_body("zapier_zulip_app_auth")
+        result = self.client_post(self.url, payload, content_type="application/json")
+        json_result = self.assert_json_success(result)
+        self.assertEqual(json_result["full_name"], "Zulip Webhook Bot")
+        self.assertEqual(json_result["email"], "webhook-bot@zulip.com")
+        self.assertIn("id", json_result)

zerver/webhooks/zapier/view.py

@@ -0,0 +1,48 @@
+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_none_or, check_string
+from zerver.lib.webhooks.common import check_send_webhook_message
+from zerver.models import UserProfile
+
+
+@webhook_view("Zapier", notify_bot_owner_on_invalid_json=False)
+@typed_endpoint
+def api_zapier_webhook(
+    request: HttpRequest,
+    user_profile: UserProfile,
+    *,
+    payload: JsonBodyPayload[WildValue],
+) -> HttpResponse:
+    if payload.get("type").tame(check_none_or(check_string)) == "auth":
+        # The bot's details are used by our Zapier app to format a connection
+        # label for users to be able to distinguish between different Zulip
+        # bots and API keys in their UI
+        return json_success(
+            request,
+            data={
+                "full_name": user_profile.full_name,
+                "email": user_profile.email,
+                "id": user_profile.id,
+            },
+        )
+
+    topic_name = payload.get("topic").tame(check_none_or(check_string))
+    content = payload.get("content").tame(check_none_or(check_string))
+
+    if topic_name is None:
+        topic_name = payload.get("subject").tame(
+            check_none_or(check_string)
+        )  # Backwards-compatibility
+        if topic_name is None:
+            raise JsonableError(_("Topic can't be empty"))
+
+    if content is None:
+        raise JsonableError(_("Content can't be empty"))
+
+    check_send_webhook_message(request, user_profile, topic_name, content)
+    return json_success(request)