mirror of
https://github.com/zulip/zulip.git
synced 2025-11-05 22:43:42 +00:00
3afc8ed7ae
This is preparatory work towards adding a Topic model. We plan to use the local variable name as 'topic' for the Topic model objects. Currently, we use *topic as the local variable name for topic names. We rename local variables of the form *topic to *topic_name so that we don't need to think about type collisions in individual code paths where we might want to talk about both Topic objects and strings for the topic name.
42 lines
1.5 KiB
Python
42 lines
1.5 KiB
Python
# Webhooks for external integrations.
|
|
|
|
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 OptionalUserSpecifiedTopicStr, check_send_webhook_message
|
|
from zerver.models import UserProfile
|
|
|
|
|
|
@webhook_view("Canarytokens")
|
|
@typed_endpoint
|
|
def api_canarytoken_webhook(
|
|
request: HttpRequest,
|
|
user_profile: UserProfile,
|
|
*,
|
|
message: JsonBodyPayload[WildValue],
|
|
user_specified_topic: OptionalUserSpecifiedTopicStr = None,
|
|
) -> HttpResponse:
|
|
"""
|
|
Construct a response to a webhook event from a Thinkst canarytoken from
|
|
canarytokens.org. Canarytokens from Thinkst's paid product have a different
|
|
schema and should use the "thinkst" integration. See linked documentation
|
|
below for a schema:
|
|
|
|
https://help.canary.tools/hc/en-gb/articles/360002426577-How-do-I-configure-notifications-for-a-Generic-Webhook-
|
|
"""
|
|
topic_name = "canarytoken alert"
|
|
body = (
|
|
f"**:alert: Canarytoken has been triggered on {message['time'].tame(check_string)}!**\n\n"
|
|
f"{message['memo'].tame(check_string)} \n\n"
|
|
f"[Manage this canarytoken]({message['manage_url'].tame(check_string)})"
|
|
)
|
|
|
|
if user_specified_topic:
|
|
topic_name = user_specified_topic
|
|
|
|
check_send_webhook_message(request, user_profile, topic_name, body)
|
|
return json_success(request)
|