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

zerver/webhooks/wordpress/doc.md

@@ -0,0 +1,35 @@
+# Zulip WordPress integration
+
+Get WordPress notifications in Zulip!
+
+{start_tabs}
+
+1. {!create-an-incoming-webhook.md!}
+
+1. {!generate-webhook-url-basic.md!}
+
+1. Add `/wp-admin/options-general.php?page=webhooks` to the end of your
+   WordPress URL, and navigate to the site. Click **Add webhook**.
+
+1. Select an **Action** from the [supported
+   events](#filtering-incoming-events) that you'd like to be notified
+   about, along with these corresponding **Fields**: `post_title`,
+   `post_type`, and `post_url`.
+
+1. Set **URL** to the URL generated above, and click **Add new webhook**.
+
+{end_tabs}
+
+{!congrats.md!}
+
+![](/static/images/integrations/wordpress/wordpress_post_created.png)
+
+{!event-filtering-additional-feature.md!}
+
+### Related documentation
+
+- [WordPress webhooks documentation][1]
+
+{!webhooks-url-specification.md!}
+
+[1]: https://wordpress.com/support/webhooks/

zerver/webhooks/wordpress/fixtures/publish_page.txt

@@ -0,0 +1 @@
+stream=wordpress&topic=WordPress%20Page&hook=publish_page&post_type=page&post_title=New%20Blog%20Page&post_url=http%3A%2F%2Fexample.com

zerver/webhooks/wordpress/fixtures/publish_post.txt

@@ -0,0 +1 @@
+stream=wordpress&topic=WordPress%20Post&hook=publish_post&post_type=post&post_title=New%20Blog%20Post&post_url=http%3A%2F%2Fexample.com

zerver/webhooks/wordpress/fixtures/publish_post_no_data_provided.txt

@@ -0,0 +1 @@
+hook=publish_post

zerver/webhooks/wordpress/fixtures/publish_post_type_not_provided.txt

@@ -0,0 +1 @@
+stream=wordpress&topic=WordPress%20Post&hook=publish_post&post_title=New%20Blog%20Post&post_url=http%3A%2F%2Fexample.com

zerver/webhooks/wordpress/fixtures/unknown_action_no_hook_provided.txt

@@ -0,0 +1 @@
+stream=wordpress&topic=WordPress%20Post&post_type=post&post_title=New%20Blog%20Post&post_url=http%3A%2F%2Fexample.com

zerver/webhooks/wordpress/tests.py

@@ -0,0 +1,86 @@
+from typing_extensions import override
+
+from zerver.lib.test_classes import WebhookTestCase
+
+
+class WordPressHookTests(WebhookTestCase):
+    def test_publish_post(self) -> None:
+        expected_topic_name = "WordPress Post"
+        expected_message = "New post published:\n* [New Blog Post](http://example.com\n)"
+
+        self.check_webhook(
+            "publish_post",
+            expected_topic_name,
+            expected_message,
+            content_type="application/x-www-form-urlencoded",
+        )
+
+    def test_publish_post_type_not_provided(self) -> None:
+        expected_topic_name = "WordPress Post"
+        expected_message = "New post published:\n* [New Blog Post](http://example.com\n)"
+
+        self.check_webhook(
+            "publish_post_type_not_provided",
+            expected_topic_name,
+            expected_message,
+            content_type="application/x-www-form-urlencoded",
+        )
+
+    def test_publish_post_no_data_provided(self) -> None:
+        # If the user forgot to configure the fields for the action in WordPress.
+        expected_topic_name = "WordPress notification"
+        expected_message = "New post published:\n* [New WordPress post](WordPress post URL)"
+
+        self.check_webhook(
+            "publish_post_no_data_provided",
+            expected_topic_name,
+            expected_message,
+            content_type="application/x-www-form-urlencoded",
+        )
+
+    def test_publish_page(self) -> None:
+        expected_topic_name = "WordPress Page"
+        expected_message = "New page published:\n* [New Blog Page](http://example.com\n)"
+
+        self.check_webhook(
+            "publish_page",
+            expected_topic_name,
+            expected_message,
+            content_type="application/x-www-form-urlencoded",
+        )
+
+    def test_unknown_action_no_data(self) -> None:
+        # Mimic check_webhook() to manually execute a negative test.
+        # Otherwise its call to send_webhook_payload() would assert on the non-success
+        # we are testing. The value of result is the error message the webhook should
+        # return if no params are sent. The fixture for this test is an empty file.
+
+        # subscribe to the target channel
+        self.subscribe(self.test_user, self.channel_name)
+
+        # post to the webhook url
+        result = self.client_post(
+            self.url,
+            self.get_body("unknown_action_no_data"),
+            content_type="application/x-www-form-urlencoded",
+        )
+
+        # check that we got the expected error message
+        self.assert_json_error(result, "Unknown WordPress webhook action: WordPress action")
+
+    def test_unknown_action_no_hook_provided(self) -> None:
+        # Similar to unknown_action_no_data, except the fixture contains valid blog post
+        # params but without the hook parameter. This should also return an error.
+
+        self.subscribe(self.test_user, self.channel_name)
+        result = self.client_post(
+            self.url,
+            self.get_body("unknown_action_no_hook_provided"),
+            content_type="application/x-www-form-urlencoded",
+        )
+
+        self.assert_json_error(result, "Unknown WordPress webhook action: WordPress action")
+
+    @override
+    def get_body(self, fixture_name: str) -> str:
+        return self.webhook_fixture_data("wordpress", fixture_name, file_type="txt")

zerver/webhooks/wordpress/view.py

@@ -0,0 +1,44 @@
+# Webhooks for external integrations.
+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 typed_endpoint
+from zerver.lib.webhooks.common import check_send_webhook_message
+from zerver.models import UserProfile
+
+PUBLISH_POST_OR_PAGE_TEMPLATE = """
+New {type} published:
+* [{title}]({url})
+""".strip()
+ALL_EVENT_TYPES = [
+    "publish_post",
+    "publish_page",
+]
+
+
+@webhook_view("WordPress", notify_bot_owner_on_invalid_json=False, all_event_types=ALL_EVENT_TYPES)
+@typed_endpoint
+def api_wordpress_webhook(
+    request: HttpRequest,
+    user_profile: UserProfile,
+    *,
+    hook: str = "WordPress action",
+    post_title: str = "New WordPress post",
+    post_type: str = "post",
+    post_url: str = "WordPress post URL",
+) -> HttpResponse:
+    # remove trailing whitespace (issue for some test fixtures)
+    hook = hook.rstrip()
+
+    if hook in ("publish_post", "publish_page"):
+        data = PUBLISH_POST_OR_PAGE_TEMPLATE.format(type=post_type, title=post_title, url=post_url)
+    else:
+        raise JsonableError(_("Unknown WordPress webhook action: {hook}").format(hook=hook))
+
+    topic_name = "WordPress notification"
+
+    check_send_webhook_message(request, user_profile, topic_name, data, hook)
+    return json_success(request)