paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-04 14:03:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

sentry-webhook: Revise documentation page to be clearer.

Browse Source 
(cherry picked from commit 3d8090a116)
This commit is contained in:
Lauryn Menard
2023-07-10 12:52:00 +02:00
committed by Alex Vandiver
parent 421ce4ffe0
commit 21c5ea1444
1 changed files with 26 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
zerver/webhooks/sentry/doc.md
View File

@@ -11,29 +11,34 @@ us](/help/contact-support) if a platform you care about is missing.
The default topic, if not set in the URL, will be the title of the
issue or event.
3. Go to your organization's **settings** in Sentry. Then go to
**Developer Settings** and click on the **Create New Integration**
button, then select **Internal Integration**. There, set the
**Webhook URL** to the URL you constructed in the above step then enable
**Alert Rule Action**. You can fill out the remaining details as
you like. If you want notifications for issues and not just events,
you can scroll down to **Webhooks** on the same page and check the
box that says **issue**. Make sure that you set up the permissions
so that the integration will be visible to the right people.
3. In Sentry, go to your organization's **Settings**, and then go to
**Developer Settings**. Click on the **Create New Integration** button,
and select **Internal Integration**. Set the **Webhook URL** to the URL
you constructed in the above step, and then enable **Alert Rule
Action**.
**NOTE:** Zulip also supports configuring this as a webhook in Sentry
— which, while easier to configure (Navigate to **Settings > Integrations
> WebHooks**) may not include the full breadth of event types. For instance,
some events, like issue assignments or issues being resolved, will not trigger
notifications with this configuration.
You can fill out the remaining details as you like. If you want
notifications for issues and not just events, you can scroll down to
**Webhooks** on the same page, and check the box that says **issue**.
Make sure that you set up the permissions so that the integration will
be visible to the right people.
4. Once you've saved the internal integration, go to **Alerts** and
click on the **Create Alert** button to create a new alert rule. Select
the project for which you want to receive notifications. Set the
conditions to be whatever you want (the events you want to be notified
for) and under **PERFORM THESE ACTIONS** select **Add an action...**
> **Send a notification via an integration** and set it to the
internal integration you created in the previous step.
!!! warn ""
**Note:** Zulip also supports configuring this as a webhook in
Sentry — which, while easier to configure (navigate to
**Settings > Integrations > WebHooks**), may not include the
full breadth of event types. For instance, some events, like issue
assignments or issues being resolved, will not trigger notifications
with this configuration.
4. Once you've saved the internal integration, go to **Alerts** and click
on the **Create Alert** button to create a new alert rule. Select the
project for which you want to receive notifications. Set the conditions
to be whatever you want (e.g. the events you want to be notified for),
and under **PERFORM THESE ACTIONS**, select **Add an action...** >
**Send a notification via an integration**, and set it to the internal
integration you created in the previous step.
{!congrats.md!}