mirror of
https://github.com/zulip/zulip.git
synced 2025-11-06 06:53:25 +00:00
ac14a8bcf5
This kind of payload that's loaded from json in the body of the request is not only used for webhooks, but also in the push bouncer, and may get used elsewhere too - so a general name is better.
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 = "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 = user_specified_topic
|
|
|
|
check_send_webhook_message(request, user_profile, topic, body)
|
|
return json_success(request)
|