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

zerver/webhooks/statuspage/doc.md

@@ -0,0 +1,33 @@
+# Zulip Statuspage integration
+
+Get Zulip notifications for your Statuspage.io subscriptions!
+
+{start_tabs}
+
+1. {!create-an-incoming-webhook.md!}
+
+1. {!generate-webhook-url-basic.md!}
+
+1. Go to your Statuspage Dashboard, and click on **Notifications**
+   near the bottom-left corner. Select the **Webhook** tab. If webhook
+   notifications are disabled, click **reactivate webhook
+   notifications now** to enable them. Click on the
+   **gear** (<i class="fa fa-cog"></i>) icon next to
+   **Subscribers**, and select **Add subscriber**.
+
+1. Set **Subscriber type** to **Webhook**. Set **Endpoint URL** to
+   the URL generated above, and provide an email address. Statuspage
+   will send email notifications to this address if the webhook endpoint
+   fails. Click **Add Subscriber**.
+
+{end_tabs}
+
+{!congrats.md!}
+
+![](/static/images/integrations/statuspage/001.png)
+
+{!event-filtering-additional-feature.md!}
+
+### Related documentation
+
+{!webhooks-url-specification.md!}

zerver/webhooks/statuspage/fixtures/component_status_update.json

@@ -0,0 +1,32 @@
+{
+    "meta": {
+        "unsubscribe": "http://mycompany24.statuspage.io/?unsubscribe=zjcdb6727vmj",
+        "documentation": "http://doers.statuspage.io/customer-notifications/webhooks/",
+        "generated_at": "2017-12-26T07:59:09.498Z"
+    },
+    "page": {
+        "id": "jb7j80lkgqvb",
+        "status_indicator": "maintenance",
+        "status_description": "Service Under Maintenance"
+    },
+    "component": {
+        "status": "under_maintenance",
+        "name": "Database component",
+        "created_at": "2017-12-26T07:57:28.743Z",
+        "updated_at": "2017-12-26T07:59:09.371Z",
+        "position": 3,
+        "description": null,
+        "showcase": true,
+        "id": "sqm6pl84wzjc",
+        "page_id": "jb7j80lkgqvb",
+        "group_id": null
+    },
+    "component_update": {
+        "old_status": "operational",
+        "new_status": "under_maintenance",
+        "created_at": "2017-12-26T07:59:09.379Z",
+        "component_type": "Component",
+        "id": "nd963wv4j30b",
+        "component_id": "sqm6pl84wzjc"
+    }
+}

zerver/webhooks/statuspage/fixtures/incident_created.json

@@ -0,0 +1,75 @@
+{
+    "meta": {
+        "unsubscribe": "http://mycompany24.statuspage.io/?unsubscribe=zjcdb6727vmj",
+        "documentation": "http://doers.statuspage.io/customer-notifications/webhooks/",
+        "generated_at": "2017-12-26T07:32:00.770Z"
+    },
+    "page": {
+        "id": "jb7j80lkgqvb",
+        "status_indicator": "critical",
+        "status_description": "All Systems Operational"
+    },
+    "incident": {
+        "name": "Database query delays",
+        "status": "identified",
+        "created_at": "2017-12-26T07:32:00.507Z",
+        "updated_at": "2017-12-26T07:32:00.603Z",
+        "monitoring_at": null,
+        "resolved_at": null,
+        "impact": "none",
+        "shortlink": "http://stspg.io/646947c1e",
+        "postmortem_ignored": false,
+        "postmortem_body": null,
+        "postmortem_body_last_updated_at": null,
+        "postmortem_published_at": null,
+        "postmortem_notified_subscribers": false,
+        "postmortem_notified_twitter": false,
+        "backfilled": false,
+        "scheduled_for": null,
+        "scheduled_until": null,
+        "scheduled_remind_prior": false,
+        "scheduled_reminded_at": null,
+        "impact_override": null,
+        "scheduled_auto_in_progress": false,
+        "scheduled_auto_completed": false,
+        "id": "z3lct0r596n4",
+        "page_id": "jb7j80lkgqvb",
+        "incident_updates": [
+            {
+                "status": "identified",
+                "body": "We just encountered that database queries are timing out resulting in inconvenience to our end users...we'll do quick fix latest by tomorrow !!!",
+                "created_at": "2017-12-26T07:32:00.548Z",
+                "wants_twitter_update": false,
+                "twitter_updated_at": null,
+                "updated_at": "2017-12-26T07:32:00.548Z",
+                "display_at": "2017-12-26T07:32:00.548Z",
+                "affected_components": [
+                    {
+                        "code": "zvdm6f7gf76j",
+                        "name": "Management Portal (example)",
+                        "old_status": "operational",
+                        "new_status": "operational"
+                    }
+                ],
+                "custom_tweet": null,
+                "deliver_notifications": true,
+                "id": "qm8bgczn0p2n",
+                "incident_id": "z3lct0r596n4"
+            }
+        ],
+        "components": [
+            {
+                "status": "operational",
+                "name": "Management Portal (example)",
+                "created_at": "2017-12-25T18:44:27.901Z",
+                "updated_at": "2017-12-25T18:44:27.901Z",
+                "position": 2,
+                "description": null,
+                "showcase": true,
+                "id": "zvdm6f7gf76j",
+                "page_id": "jb7j80lkgqvb",
+                "group_id": null
+            }
+        ]
+    }
+}

zerver/webhooks/statuspage/fixtures/incident_update.json

@@ -0,0 +1,96 @@
+{
+    "meta": {
+        "unsubscribe": "http://mycompany24.statuspage.io/?unsubscribe=zjcdb6727vmj",
+        "documentation": "http://doers.statuspage.io/customer-notifications/webhooks/",
+        "generated_at": "2017-12-26T07:37:21.000Z"
+    },
+    "page": {
+        "id": "jb7j80lkgqvb",
+        "status_indicator": "none",
+        "status_description": "All Systems Operational"
+    },
+    "incident": {
+        "name": "Database query delays",
+        "status": "resolved",
+        "created_at": "2017-12-26T07:32:00.507Z",
+        "updated_at": "2017-12-26T07:37:20.837Z",
+        "monitoring_at": null,
+        "resolved_at": "2017-12-26T07:37:20.785Z",
+        "impact": "none",
+        "shortlink": "http://stspg.io/646947c1e",
+        "postmortem_ignored": false,
+        "postmortem_body": null,
+        "postmortem_body_last_updated_at": null,
+        "postmortem_published_at": null,
+        "postmortem_notified_subscribers": false,
+        "postmortem_notified_twitter": false,
+        "backfilled": false,
+        "scheduled_for": null,
+        "scheduled_until": null,
+        "scheduled_remind_prior": false,
+        "scheduled_reminded_at": null,
+        "impact_override": null,
+        "scheduled_auto_in_progress": false,
+        "scheduled_auto_completed": false,
+        "id": "z3lct0r596n4",
+        "page_id": "jb7j80lkgqvb",
+        "incident_updates": [
+            {
+                "status": "resolved",
+                "body": "The database issue is resolved.",
+                "created_at": "2017-12-26T07:37:20.785Z",
+                "wants_twitter_update": false,
+                "twitter_updated_at": null,
+                "updated_at": "2017-12-26T07:37:20.785Z",
+                "display_at": "2017-12-26T07:37:20.785Z",
+                "affected_components": [
+                    {
+                        "code": "zvdm6f7gf76j",
+                        "name": "Management Portal (example)",
+                        "old_status": "operational",
+                        "new_status": "operational"
+                    }
+                ],
+                "custom_tweet": null,
+                "deliver_notifications": true,
+                "id": "cdwfdrjlp53y",
+                "incident_id": "z3lct0r596n4"
+            },
+            {
+                "status": "identified",
+                "body": "We just encountered that database queries are timing out resulting in inconvenience to our end users...we'll do quick fix latest by tomorrow !!!",
+                "created_at": "2017-12-26T07:32:00.548Z",
+                "wants_twitter_update": false,
+                "twitter_updated_at": null,
+                "updated_at": "2017-12-26T07:32:00.548Z",
+                "display_at": "2017-12-26T07:32:00.548Z",
+                "affected_components": [
+                    {
+                        "code": "zvdm6f7gf76j",
+                        "name": "Management Portal (example)",
+                        "old_status": "operational",
+                        "new_status": "operational"
+                    }
+                ],
+                "custom_tweet": null,
+                "deliver_notifications": true,
+                "id": "qm8bgczn0p2n",
+                "incident_id": "z3lct0r596n4"
+            }
+        ],
+        "components": [
+            {
+                "status": "operational",
+                "name": "Management Portal (example)",
+                "created_at": "2017-12-25T18:44:27.901Z",
+                "updated_at": "2017-12-25T18:44:27.901Z",
+                "position": 2,
+                "description": null,
+                "showcase": true,
+                "id": "zvdm6f7gf76j",
+                "page_id": "jb7j80lkgqvb",
+                "group_id": null
+            }
+        ]
+    }
+}

zerver/webhooks/statuspage/tests.py

@@ -0,0 +1,51 @@
+from zerver.lib.test_classes import WebhookTestCase
+
+
+class StatuspageHookTests(WebhookTestCase):
+    def test_statuspage_incident(self) -> None:
+        expected_topic_name = "Database query delays: All Systems Operational"
+        expected_message = """
+**Database query delays**:
+* State: **identified**
+* Description: We just encountered that database queries are timing out resulting in inconvenience to our end users...we'll do quick fix latest by tomorrow !!!
+""".strip()
+        self.check_webhook(
+            "incident_created",
+            expected_topic_name,
+            expected_message,
+            content_type="application/x-www-form-urlencoded",
+        )
+
+    def test_statuspage_incident_update(self) -> None:
+        expected_topic_name = "Database query delays: All Systems Operational"
+        expected_message = """
+**Database query delays**:
+* State: **resolved**
+* Description: The database issue is resolved.
+""".strip()
+        self.check_webhook(
+            "incident_update",
+            expected_topic_name,
+            expected_message,
+            content_type="application/x-www-form-urlencoded",
+        )
+
+    def test_statuspage_component(self) -> None:
+        expected_topic_name = "Database component: Service Under Maintenance"
+        expected_message = "**Database component** has changed status from **operational** to **under_maintenance**."
+        self.check_webhook(
+            "component_status_update",
+            expected_topic_name,
+            expected_message,
+            content_type="application/x-www-form-urlencoded",
+        )
+
+    def test_statuspage_anomalous_payload(self) -> None:
+        result = self.client_post(
+            self.url,
+            {},
+            content_type="application/json",
+        )
+        self.assert_json_error(
+            result, "Unable to parse request: Did Statuspage generate this event?", 400
+        )

zerver/webhooks/statuspage/view.py

@@ -0,0 +1,75 @@
+# Webhooks for external integrations.
+from django.http import HttpRequest, HttpResponse
+
+from zerver.decorator import webhook_view
+from zerver.lib.exceptions import AnomalousWebhookPayloadError
+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
+
+INCIDENT_TEMPLATE = """
+**{name}**:
+* State: **{state}**
+* Description: {content}
+""".strip()
+
+COMPONENT_TEMPLATE = "**{name}** has changed status from **{old_status}** to **{new_status}**."
+
+TOPIC_TEMPLATE = "{name}: {description}"
+
+ALL_EVENT_TYPES = ["incident", "component"]
+
+
+def get_incident_events_body(payload: WildValue) -> str:
+    return INCIDENT_TEMPLATE.format(
+        name=payload["incident"]["name"].tame(check_string),
+        state=payload["incident"]["status"].tame(check_string),
+        content=payload["incident"]["incident_updates"][0]["body"].tame(check_string),
+    )
+
+
+def get_components_update_body(payload: WildValue) -> str:
+    return COMPONENT_TEMPLATE.format(
+        name=payload["component"]["name"].tame(check_string),
+        old_status=payload["component_update"]["old_status"].tame(check_string),
+        new_status=payload["component_update"]["new_status"].tame(check_string),
+    )
+
+
+def get_incident_topic(payload: WildValue) -> str:
+    return TOPIC_TEMPLATE.format(
+        name=payload["incident"]["name"].tame(check_string),
+        description=payload["page"]["status_description"].tame(check_string),
+    )
+
+
+def get_component_topic(payload: WildValue) -> str:
+    return TOPIC_TEMPLATE.format(
+        name=payload["component"]["name"].tame(check_string),
+        description=payload["page"]["status_description"].tame(check_string),
+    )
+
+
+@webhook_view("Statuspage", all_event_types=ALL_EVENT_TYPES)
+@typed_endpoint
+def api_statuspage_webhook(
+    request: HttpRequest,
+    user_profile: UserProfile,
+    *,
+    payload: JsonBodyPayload[WildValue],
+) -> HttpResponse:
+    if "incident" in payload:
+        event = "incident"
+        topic_name = get_incident_topic(payload)
+        body = get_incident_events_body(payload)
+    elif "component" in payload:
+        event = "component"
+        topic_name = get_component_topic(payload)
+        body = get_components_update_body(payload)
+    else:
+        raise AnomalousWebhookPayloadError
+
+    check_send_webhook_message(request, user_profile, topic_name, body, event)
+    return json_success(request)