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

zerver/webhooks/ifttt/doc.md

@@ -0,0 +1,39 @@
+# Zulip IFTTT integration
+
+IFTTT supports integrations with hundreds of
+[physical and digital products](https://ifttt.com/services), like
+dishwashers, cars, web services, and more. Get IFTTT notifications directly
+in Zulip.
+
+{start_tabs}
+
+1. {!create-an-incoming-webhook.md!}
+
+1. {!generate-webhook-url-basic.md!}
+
+1. Create an [IFTTT account](https://ifttt.com/join). Select the service
+   you'd like to receive notifications from as `this`. Select
+   **Webhooks** as `that`. Select the **Make a web request** action.
+
+1. Set **URL** to the URL generated above. Set **Method** to `POST`,
+   and set **Content Type** to `application/json`.
+
+1. Set **Body** to a JSON object with two parameters: `content` and
+   `topic`, like so:
+
+    `{"content": "message body", "topic": "message topic"}`
+
+    You will most likely want to specify some IFTTT **Ingredients** to
+    customize the topic and content of your messages. Click **Add ingredient**
+    to see the available options and customize the `content` and `topic`
+    parameters as necessary.
+
+1.  Click **Create action**, and click **Finish**.
+
+{end_tabs}
+
+You're done! You should now receive notifications in Zulip.
+
+### Related documentation
+
+{!webhooks-url-specification.md!}

zerver/webhooks/ifttt/fixtures/correct_subject_and_body.json

@@ -0,0 +1,4 @@
+{
+  "subject": "Email sent from email@email.com",
+  "content": "Email subject: Subject"
+}

zerver/webhooks/ifttt/fixtures/correct_topic_and_body.json

@@ -0,0 +1,4 @@
+{
+  "topic": "Email sent from email@email.com",
+  "content": "Email subject: Subject"
+}

zerver/webhooks/ifttt/fixtures/invalid_payload_with_dict_content.json

@@ -0,0 +1,4 @@
+{
+  "topic": "Email sent from email@email.com",
+  "content": {"wrong": "example"}
+}

zerver/webhooks/ifttt/fixtures/invalid_payload_with_dict_topic.json

@@ -0,0 +1,4 @@
+{
+  "topic": {"wrong": "example"},
+  "content": "Email subject: Subject"
+}

zerver/webhooks/ifttt/fixtures/invalid_payload_with_missing_content.json

@@ -0,0 +1,3 @@
+{
+  "topic": "Email sent from email@email.com"
+}

zerver/webhooks/ifttt/fixtures/invalid_payload_with_missing_topic.json

@@ -0,0 +1,3 @@
+{
+  "content": "Email subject: Subject"
+}

zerver/webhooks/ifttt/tests.py

@@ -0,0 +1,37 @@
+from zerver.lib.test_classes import WebhookTestCase
+
+
+class IFTTTHookTests(WebhookTestCase):
+    def test_ifttt_when_subject_and_body_are_correct(self) -> None:
+        expected_topic_name = "Email sent from email@email.com"
+        expected_message = "Email subject: Subject"
+        self.check_webhook("correct_subject_and_body", expected_topic_name, expected_message)
+
+    def test_ifttt_when_topic_and_body_are_correct(self) -> None:
+        expected_topic_name = "Email sent from email@email.com"
+        expected_message = "Email subject: Subject"
+        self.check_webhook("correct_topic_and_body", expected_topic_name, expected_message)
+
+    def test_ifttt_when_topic_is_missing(self) -> None:
+        self.url = self.build_webhook_url()
+        payload = self.get_body("invalid_payload_with_missing_topic")
+        result = self.client_post(self.url, payload, content_type="application/json")
+        self.assert_json_error(result, "Topic can't be empty")
+
+    def test_ifttt_when_content_is_missing(self) -> None:
+        self.url = self.build_webhook_url()
+        payload = self.get_body("invalid_payload_with_missing_content")
+        result = self.client_post(self.url, payload, content_type="application/json")
+        self.assert_json_error(result, "Content can't be empty")
+
+    def test_ifttt_when_topic_is_dict(self) -> None:
+        self.url = self.build_webhook_url()
+        payload = self.get_body("invalid_payload_with_dict_topic")
+        result = self.client_post(self.url, payload, content_type="application/json")
+        self.assert_json_error(result, "Malformed payload")
+
+    def test_ifttt_when_content_is_dict(self) -> None:
+        self.url = self.build_webhook_url()
+        payload = self.get_body("invalid_payload_with_dict_content")
+        result = self.client_post(self.url, payload, content_type="application/json")
+        self.assert_json_error(result, "Malformed payload")

zerver/webhooks/ifttt/view.py

@@ -0,0 +1,40 @@
+from django.core.exceptions import ValidationError
+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("IFTTT")
+@typed_endpoint
+def api_ifttt_webhook(
+    request: HttpRequest,
+    user_profile: UserProfile,
+    *,
+    payload: JsonBodyPayload[WildValue],
+) -> HttpResponse:
+    try:
+        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"))
+
+    except ValidationError:
+        raise JsonableError(_("Malformed payload"))
+
+    check_send_webhook_message(request, user_profile, topic_name, content)
+    return json_success(request)