Notifications: Add support for webhooks #7311

kiblik · 2022-12-21T14:48:25Z

We would like to do an implementation similar to this: https://docs.gitlab.com/ee/user/project/integrations/webhooks.html

Events will be published via notifications

The whole functionality is described in the documentation section. This is an image which is rendered by mermaid

Maffooch · 2022-12-23T21:34:31Z

@kiblik this is looking really interesting so far. The only critique I have thus far is that it appears there is only support for one web hook at a time. I think it would be good to allow for an arbitrary amount of web hooks. Sorta like how the Jira integration works where you can connect an arbitrary amount of Jira servers and push to them according to how they are configured.

kiblik · 2022-12-24T10:45:57Z

@Maffooch, thank you for the feedback. I can add management of multiple webhook endpoints.

Btw, what do you think about User notifications? Do they make sense to you? They are disabled for MS Teams.

Or the combination of your idea and my question: One endpoint System notification endpoint and each user will be able to define his/her/they own endpoint.

Maffooch · 2022-12-26T17:38:11Z

I would think adding a web hook url would require a higher permission (I think maintainer would be sufficient) so adding user levels would be a little redundant.

kiblik · 2023-01-23T17:16:49Z

I would think adding a web hook url would require a higher permission (I think maintainer would be sufficient) so adding user levels would be a little redundant.

@Maffooch, we see a possible use case when the user should be able to define his own endpoint.
What about this:

add user = ForeignKey(Dojo_User, null=True, blank=True) to Webhook_Endpoints
regular user is able to create an endpoint assigned only to himself
high-privileged user is able to assign an endpoint to anybody and also to nobody
if it will be assigned to the user, user notifications will be processed/send (the user will also define from which products he/she/they would like to receive notifications)
if it will not be assigned to the user, system notifications will be processed/send

Maffooch · 2023-01-24T16:38:31Z

I think that sounds reasonable

Maffooch · 2023-02-09T15:43:23Z

Hey @kiblik how are things going on this? Can I be of any help on this PR (or any of your others)?

github-actions · 2023-02-09T23:10:37Z

This pull request has conflicts, please resolve those before we can evaluate the pull request.

kiblik · 2023-02-09T23:10:51Z

Hey @kiblik how are things going on this? Can I be of any help on this PR (or any of your others)?

So, my priorities were on the other tasks recently but I had planned to come back to this functionality during the next week.

github-actions · 2023-02-21T13:59:22Z

Conflicts have been resolved. A maintainer will review the pull request shortly.

accesslint

There are accessibility issues in these changes.

accesslint · 2023-02-21T13:59:38Z

dojo/templates/dojo/notification_webhooks.html

+                    <h3 class="has-filters">
+                        Notification Webhook List
+                        <div class="dropdown pull-right">
+                            <button id="show-filters" data-toggle="collapse" data-target="#the-filters" class="btn btn-primary toggle-filters"> <i class="fa-solid fa-filter"></i> <i class="caret"></i> </button>


Looks like this element is missing an accessible name or label. That makes it hard for people using screen readers or voice control to use the control.

accesslint · 2023-02-21T13:59:38Z

dojo/templates/dojo/view_notification_webhooks.html

+                    <h3 class="has-filters">
+                        Notification Webhook List
+                        <div class="dropdown pull-right">
+                            <button id="show-filters" data-toggle="collapse" data-target="#the-filters" class="btn btn-primary toggle-filters"> <i class="fa-solid fa-filter"></i> <i class="caret"></i> </button>


Looks like this element is missing an accessible name or label. That makes it hard for people using screen readers or voice control to use the control.

accesslint · 2023-02-21T13:59:38Z

dojo/templates/dojo/notification_webhooks.html

+                        <div class="dropdown pull-right">
+                            <button id="show-filters" data-toggle="collapse" data-target="#the-filters" class="btn btn-primary toggle-filters"> <i class="fa-solid fa-filter"></i> <i class="caret"></i> </button>
+                            {% if "dojo.add_notification_webhook"|has_configuration_permission %}
+                            <button class="btn btn-primary dropdown-toggle" type="button" id="dropdownMenu1"


Looks like this element is missing an accessible name or label. That makes it hard for people using screen readers or voice control to use the control.

accesslint · 2023-02-21T13:59:38Z

dojo/templates/dojo/view_notification_webhooks.html

+                        <div class="dropdown pull-right">
+                            <button id="show-filters" data-toggle="collapse" data-target="#the-filters" class="btn btn-primary toggle-filters"> <i class="fa-solid fa-filter"></i> <i class="caret"></i> </button>
+                            {% if "dojo.add_notification_webhook"|has_configuration_permission %}
+                            <button class="btn btn-primary dropdown-toggle" type="button" id="dropdownMenu1"


Looks like this element is missing an accessible name or label. That makes it hard for people using screen readers or voice control to use the control.

dojo/models.py

github-actions · 2023-03-03T06:53:19Z

This pull request has conflicts, please resolve those before we can evaluate the pull request.

github-actions · 2023-03-09T23:44:06Z

Conflicts have been resolved. A maintainer will review the pull request shortly.

Co-authored-by: Cody Maffucci <[email protected]>

kiblik · 2024-09-12T17:29:29Z

I fixed the lastest comments from @cneill. I hope this PR is (finally after 1 year, 8 months, 22 days) ready for merge 😄

cneill

Looks good! 🎉 Thanks for taking care of those final comments

github-actions bot added docker docs integration_tests New Migration Adding a new migration file. Take care when merging. ui labels Dec 21, 2022

kiblik force-pushed the notifications_webhooks branch from 2438ec8 to 061a125 Compare January 9, 2023 22:44

kiblik force-pushed the notifications_webhooks branch from fa88b41 to 34404ce Compare January 23, 2023 15:37

github-actions bot added the apiv2 label Jan 23, 2023

github-actions bot added the conflicts-detected label Feb 9, 2023

kiblik force-pushed the notifications_webhooks branch from c19ab2c to 85b464b Compare February 21, 2023 13:59

github-actions bot removed the conflicts-detected label Feb 21, 2023

accesslint bot reviewed Feb 21, 2023

View reviewed changes

kiblik force-pushed the notifications_webhooks branch 2 times, most recently from 08c44bd to 0daeeab Compare March 1, 2023 13:01

damiencarol reviewed Mar 1, 2023

View reviewed changes

dojo/models.py Outdated Show resolved Hide resolved

github-actions bot added the conflicts-detected label Mar 3, 2023

kiblik force-pushed the notifications_webhooks branch from 0daeeab to 4a6c3f1 Compare March 9, 2023 23:39

github-actions bot removed the conflicts-detected label Mar 9, 2023

kiblik force-pushed the notifications_webhooks branch from 4a6c3f1 to a695ce1 Compare March 10, 2023 08:38

kiblik and others added 25 commits September 12, 2024 19:23

More tests

7b8d6bf

Small adjustments

50b4562

Set max_length

503ebbd

Better handle nones

5d97a21

Add basic doc + fix findings_list

b630f90

Update docs

6427496

Clean ruff

f4f43ef

Fix db_mig

fb50101

Fix long notes

416d040

Clean ruff

fb10310

Move "webhook.endpoint" from debug docker to dev

5e1877b

Make fields "editable=False"

f69dcdd

Try to fix accesslint

47fd8c1

Use class-based choices

82d1652

Shorter default timeout

ad3beb2

Update dojo/notifications/views.py

3198e81

Co-authored-by: Cody Maffucci <[email protected]>

Finish preprocess_request

a1868e5

Update dojo/notifications/helper.py

219886d

Co-authored-by: Cody Maffucci <[email protected]>

Show error-times as hint

454e76d

Try to fix accesslint

f2e5bd1

Rename url to url_ui and add url_api

6dbbe25

inc db_mig

f985040

Accept any 2xx as successful

d641327

Add permission checker for item in menu

95453cc

Fix editing for superadmin

3cc64f7

kiblik force-pushed the notifications_webhooks branch from 96b1730 to 3cc64f7 Compare September 12, 2024 17:23

cneill approved these changes Sep 13, 2024

View reviewed changes

Maffooch merged commit 330462d into DefectDojo:dev Sep 14, 2024
72 of 73 checks passed

kiblik deleted the notifications_webhooks branch September 14, 2024 09:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Notifications: Add support for webhooks #7311

Notifications: Add support for webhooks #7311

kiblik commented Dec 21, 2022 •

edited

Loading

Maffooch commented Dec 23, 2022

kiblik commented Dec 24, 2022

Maffooch commented Dec 26, 2022

kiblik commented Jan 23, 2023

Maffooch commented Jan 24, 2023

Maffooch commented Feb 9, 2023

github-actions bot commented Feb 9, 2023

kiblik commented Feb 9, 2023

github-actions bot commented Feb 21, 2023

accesslint bot left a comment

accesslint bot Feb 21, 2023

accesslint bot Feb 21, 2023

accesslint bot Feb 21, 2023

accesslint bot Feb 21, 2023

github-actions bot commented Mar 3, 2023

github-actions bot commented Mar 9, 2023

kiblik commented Sep 12, 2024

cneill left a comment

Notifications: Add support for webhooks #7311

Notifications: Add support for webhooks #7311

Conversation

kiblik commented Dec 21, 2022 • edited Loading

Maffooch commented Dec 23, 2022

kiblik commented Dec 24, 2022

Maffooch commented Dec 26, 2022

kiblik commented Jan 23, 2023

Maffooch commented Jan 24, 2023

Maffooch commented Feb 9, 2023

github-actions bot commented Feb 9, 2023

kiblik commented Feb 9, 2023

github-actions bot commented Feb 21, 2023

accesslint bot left a comment

Choose a reason for hiding this comment

accesslint bot Feb 21, 2023

Choose a reason for hiding this comment

accesslint bot Feb 21, 2023

Choose a reason for hiding this comment

accesslint bot Feb 21, 2023

Choose a reason for hiding this comment

accesslint bot Feb 21, 2023

Choose a reason for hiding this comment

github-actions bot commented Mar 3, 2023

github-actions bot commented Mar 9, 2023

kiblik commented Sep 12, 2024

cneill left a comment

Choose a reason for hiding this comment

kiblik commented Dec 21, 2022 •

edited

Loading