Files
zulip/zerver/webhooks/zapier/view.py
Prakhar Pratyush 3afc8ed7ae webhooks: Rename *topic local variables to *topic_name.
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.
2024-01-17 08:35:29 -08:00

49 lines
1.7 KiB
Python

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("Zapier", notify_bot_owner_on_invalid_json=False)
@typed_endpoint
def api_zapier_webhook(
request: HttpRequest,
user_profile: UserProfile,
*,
payload: JsonBodyPayload[WildValue],
) -> HttpResponse:
if payload.get("type").tame(check_none_or(check_string)) == "auth":
# The bot's details are used by our Zapier app to format a connection
# label for users to be able to distinguish between different Zulip
# bots and API keys in their UI
return json_success(
request,
data={
"full_name": user_profile.full_name,
"email": user_profile.email,
"id": user_profile.id,
},
)
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"))
check_send_webhook_message(request, user_profile, topic_name, content)
return json_success(request)