V14: Webhook Management API #15147

bjarnef · 2023-11-06T19:10:54Z

Prerequisites

I have added steps to test this contribution in the description below

Description

Added webhooks to Management API and models, which we can generate models for in the new backoffice.
See related PR for new backoffice here: umbraco/Umbraco.CMS.Backoffice#962

github-actions · 2023-11-06T19:11:08Z

Hi there @bjarnef, thank you for this contribution! 👍

While we wait for one of the Core Collaborators team to have a look at your work, we wanted to let you know about that we have a checklist for some of the things we will consider during review:

It's clear what problem this is solving, there's a connected issue or a description of what the changes do and how to test them
The automated tests all pass (see "Checks" tab on this PR)
The level of security for this contribution is the same or improved
The level of performance for this contribution is the same or improved
Avoids creating breaking changes; note that behavioral changes might also be perceived as breaking
If this is a new feature, Umbraco HQ provided guidance on the implementation beforehand
💡 The contribution looks original and the contributor is presumably allowed to share it

Don't worry if you got something wrong. We like to think of a pull request as the start of a conversation, we're happy to provide guidance on improving your contribution.

If you realize that you might want to make some changes then you can do that by adding new commits to the branch you created for this work and pushing new commits. They should then automatically show up as updates to this pull request.

Thanks, from your friendly Umbraco GitHub bot 🤖 🙂

bjarnef · 2023-11-06T19:45:39Z

@Zeegaan @bergmania I have added this while working on umbraco/Umbraco.CMS.Backoffice#962

I think the CRUD operation methods should take a parameter Guid userKey like in ILanguageService?

Futhermore should the IWebhookService method return Task<IWebhook> instead of Task<Webhook>?

or maybe Task<Attempt<IWebhook?, WebhookOperationStatus>>?

It seems to Update method should also return Webhook (or IWebhook).

Should we have Constants.UdiEntityType.Webhook as well?

The API version should probably be changes as well for this :)

georgebid · 2023-11-07T10:19:17Z

Morning @bjarnef, thanks for the PR! Someone on the team will review this soon 😄

bjarnef · 2023-11-07T10:30:35Z

@georgebid it definitely need some more work, but it would be great with some feedback from HQ. Maybe it also requires some additional changes regarding webhooks in v13/dev branch.

I know @kjac has worked on the management API, so maybe he could have a look at some point 😎

georgebid · 2023-11-07T10:33:07Z

Ah yes, @bjarnef sorry I totally missed that this was marked as a Draft, but yes don't worry - I am sure someone from HQ will be in touch soon! 🚀

bjarnef · 2023-11-15T12:22:50Z

@elit0451 maybe something you want to review too since you have worked much with the (content) delivery API.
I need to merge latest changes regarding webhooks and later when having the models, I can look at the related backoffice PR 😎

… feature/management-api-webhook

bjarnef · 2023-11-15T12:43:41Z

I think we also need the changes from #15180 but it seems these haven't been merged to v14/dev branch yet.

Zeegaan · 2023-11-16T09:56:55Z

Should be updated now 😁

… feature/management-api-webhook # Conflicts: # src/Umbraco.Core/Services/OperationStatus/WebhookOperationStatus.cs

bjarnef · 2023-11-16T10:36:57Z

@Zeegaan I have updated that and resolved the conflicts.

I noticed an ambiguous reference because WebhookResponseModel exists in Umbraco.Cms.Core.Models and also Umbraco.Cms.Api.Management.ViewModels.Webhook

… feature/management-api-webhook

… feature/management-api-webhook # Conflicts: # src/Umbraco.Core/Services/LanguageService.cs

bjarnef · 2024-02-19T17:48:41Z

I noticed CreatedAtAction() has changed and updated the usage in:
7b48a71

Should the routeValues be nullable? and perhaps an overload as before accepting Guid as identifier?

Nevermind, I noticed theres a new method CreatedAtId<T>() and CreatedAtPath<T>(), which call CreatedAtAction<T>().

bjarnef · 2024-02-21T20:56:36Z

It would be great if we could review/merge this, so I can continue the webhooks workspace in backoffice repository 😃

Zeegaan · 2024-02-22T08:40:36Z

@bjarnef We are aware of this, and we have set aside sprint time to review, but we are really busy with all kinds of v14 stuff 🏃‍♂️

I will get to this as soon as I am able 😁

bjarnef · 2024-02-22T08:50:38Z

@Zeegaan yeah, I know.. and seems there are lots to do. It is after all a major overhaul and cleanup/refactor of 10 year old code in some parts of the backoffice.
But I guess it need this sooner or later 😁

and would love to help with the frontend (in backoffice) webhooks workspace, but I neeed to generate the models from v14/dev branch to continue that work 😅

Zeegaan

Sorry for this taking a long time, finally got around to it 😁
Have a few comments, but overall looks splendid! 💪

src/Umbraco.Cms.Api.Management/Controllers/Webhook/ByKeyWebhookController.cs

src/Umbraco.Cms.Api.Management/Controllers/Webhook/DeleteWebhookController.cs

src/Umbraco.Cms.Api.Management/Controllers/Webhook/CreateWebhookController.cs

src/Umbraco.Cms.Api.Management/ViewModels/Webhook/CreateWebhookRequestModel.cs

…kController.cs Co-authored-by: Nikolaj Geisle <[email protected]>

…kRequestModel.cs Co-authored-by: Nikolaj Geisle <[email protected]>

bjarnef · 2024-02-23T12:07:24Z

Regarding the CurrentUserKey() and audits of the the webhook e.g. was created from backoffice or from code is need further adjustments. IIRC languages have this, but not audit in backoffice UI.

Maybe the webhook model need some adjustments as well. I haven't checked with the latest changes with was added/adjusted in v13.

The webhook inherits TEntity IIRC, but the UI doesn't allow setting a werbhook friendly name yet I think. In case this will be added it could use the header name field in backoffice, but not if it is optional as that requires a value.
Maybe only in v14 later and then webhook model with a name property as well.

Zeegaan · 2024-02-23T12:38:57Z

Yea I think a friendly name at some point would be nice, but I think we should aim for feature parity for now, and then we can always sprinkle stuff on top later 😁

I will give this a test for now, and come back if the models needs adjustment 👍

bjarnef · 2024-02-23T14:48:33Z

src/Umbraco.Cms.Api.Management/ViewModels/Webhook/CreateWebhookRequestModel.cs

+
+public class CreateWebhookRequestModel : WebhookModelBase
+{
+    public Guid? Id { get; set; }


@Zeegaan does UpdateWebhookRequestModel also need this and WebhookResponseModel?

Should it be part of WebhookModelBase instead then?

No just the CreateModel! 😁
It's basically just so you can specify an Id upon creation 👍

Okay, but we should probably add it to WebhookResponseModel model as well then - just like with datatype:

Umbraco-CMS/src/Umbraco.Cms.Api.Management/ViewModels/DataType/DataTypeResponseModel.cs

Line 5 in 268babf

public Guid Id { get; set; }

I added Guid to WebhookResponseModel:
5005138

I noticed other response models inherits from NamedItemResponseModelBase which inherits from ItemResponseModelBase and has Guid Id.

E.g. MemberGroupItemResponseModel inherits from NamedItemResponseModelBase.

I guess WebhookResponseModel can inherits from NamedItemResponseModelBase as webhook inherits TEntity or from ItemResponseModelBase ?

ItemResponseModelBase are for the item endpoints, so no more inheritance please 🙈

…okController.cs Co-authored-by: Nikolaj Geisle <[email protected]>

Zeegaan · 2024-02-26T13:02:57Z

@bjarnef I've added some missing mapping and the new auth policies, but works like a charm now 😁
Will merge when the tests pass 🚀

bjarnef · 2024-02-26T21:13:45Z

@Zeegaan do we need something like this to get a paged result of webhooks?
https://github.com/umbraco/Umbraco-CMS/blob/v14/dev/src/Umbraco.Cms.Api.Management/Controllers/Language/AllLanguageController.cs

I noticed after generating models in umbraco/Umbraco.CMS.Backoffice#962 that WebhookResource has two methods to get webhooks:

getWebhookById
getWebhookItem

where LanguageResource has:

getLanguageByIsoCode
getItemLanguage
getLanguage (paged result returning PagedLanguageResponseModel)

Zeegaan · 2024-02-29T11:23:25Z

Yes seems like it 😁

bjarnef · 2024-02-29T13:07:48Z

@Zeegaan added in #15802

Add webhook to management api

9a00994

Update webhook controllers

3a7f7ce

bjarnef added 5 commits November 6, 2023 22:46

Add ByKey webhook controller

e0b2a15

Fix typo

f6b690e

Fix typo

651913f

Update multiple webhooks

5387c14

Update using

547f64d

This was referenced Nov 7, 2023

Add comments to methods in IWebHookService #15151

Merged

Add tree access to webhooks #15156

Merged

bjarnef added 5 commits November 15, 2023 13:24

Merge branch 'v14/dev' of https://github.com/umbraco/Umbraco-CMS into…

252f7cb

… feature/management-api-webhook

Remove duplicate constant after merge

9636453

Fix typo in file name

f0bab65

Update casing of IWebhookService

af0f2fb

Fix typo

1e86abd

bjarnef added 3 commits November 16, 2023 11:23

Merge branch 'v14/dev' of https://github.com/umbraco/Umbraco-CMS into…

15fb5a3

… feature/management-api-webhook # Conflicts: # src/Umbraco.Core/Services/OperationStatus/WebhookOperationStatus.cs

Use Webhook entity type

94142e2

Fix ambiguous reference

6cdce7a

bjarnef mentioned this pull request Nov 28, 2023

Feature: Webhooks workspace umbraco/Umbraco.CMS.Backoffice#962

Merged

7 tasks

bjarnef added 2 commits December 29, 2023 14:59

Merge branch 'v14/dev' of https://github.com/umbraco/Umbraco-CMS into…

e31a263

… feature/management-api-webhook

Update webhook mapping

cb35d1d

bjarnef marked this pull request as ready for review January 1, 2024 22:57

Merge branch 'v14/dev' of https://github.com/umbraco/Umbraco-CMS into…

6d0398f

… feature/management-api-webhook # Conflicts: # src/Umbraco.Core/Services/LanguageService.cs

bjarnef changed the title ~~Feature: Management API - Webhook~~ V14: Webhook Management API Feb 19, 2024

Update after change of CreatedAtAction

7b48a71

Use CreatedAtId instead

6f4675e

Zeegaan requested changes Feb 23, 2024

View reviewed changes

bjarnef and others added 3 commits February 23, 2024 12:56

Update src/Umbraco.Cms.Api.Management/Controllers/Webhook/ByKeyWebhoo…

a17496a

…kController.cs Co-authored-by: Nikolaj Geisle <[email protected]>

Update src/Umbraco.Cms.Api.Management/Controllers/Webhook/ByKeyWebhoo…

deb01d3

…kController.cs Co-authored-by: Nikolaj Geisle <[email protected]>

Update src/Umbraco.Cms.Api.Management/ViewModels/Webhook/CreateWebhoo…

3a675f0

…kRequestModel.cs Co-authored-by: Nikolaj Geisle <[email protected]>

bjarnef commented Feb 23, 2024

View reviewed changes

bjarnef and others added 7 commits February 23, 2024 16:31

Update src/Umbraco.Cms.Api.Management/Controllers/Webhook/DeleteWebho…

8180ede

…okController.cs Co-authored-by: Nikolaj Geisle <[email protected]>

Update src/Umbraco.Cms.Api.Management/Controllers/Webhook/CreateWebho…

268babf

…okController.cs Co-authored-by: Nikolaj Geisle <[email protected]>

Add Guid to WebhookResponseModel

5005138

Cleanup

b5969a3

Add Auth

ac7b3c1

Move webhook logic from backoffice to management api

e2461b6

Add mapping

7d7f2f1

Zeegaan merged commit f47830b into umbraco:v14/dev Feb 26, 2024
12 of 15 checks passed

Zeegaan added the project/bellissima AKA "the new backoffice" label Feb 26, 2024

bjarnef deleted the feature/management-api-webhook branch February 26, 2024 14:04

bergmania added the release/14.0.0 label Apr 10, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

V14: Webhook Management API #15147

V14: Webhook Management API #15147

bjarnef commented Nov 6, 2023 •

edited

Loading

github-actions bot commented Nov 6, 2023 •

edited by georgebid

Loading

bjarnef commented Nov 6, 2023 •

edited

Loading

georgebid commented Nov 7, 2023 •

edited

Loading

bjarnef commented Nov 7, 2023

georgebid commented Nov 7, 2023 •

edited

Loading

bjarnef commented Nov 15, 2023

bjarnef commented Nov 15, 2023

Zeegaan commented Nov 16, 2023

bjarnef commented Nov 16, 2023

bjarnef commented Feb 19, 2024 •

edited

Loading

bjarnef commented Feb 21, 2024

Zeegaan commented Feb 22, 2024

bjarnef commented Feb 22, 2024 •

edited

Loading

Zeegaan left a comment

bjarnef commented Feb 23, 2024

Zeegaan commented Feb 23, 2024

bjarnef Feb 23, 2024

Zeegaan Feb 23, 2024

bjarnef Feb 23, 2024

bjarnef Feb 23, 2024

bjarnef Feb 23, 2024

Zeegaan Feb 26, 2024

Zeegaan commented Feb 26, 2024

bjarnef commented Feb 26, 2024

Zeegaan commented Feb 29, 2024

bjarnef commented Feb 29, 2024

V14: Webhook Management API #15147

V14: Webhook Management API #15147

Conversation

bjarnef commented Nov 6, 2023 • edited Loading

Prerequisites

Description

github-actions bot commented Nov 6, 2023 • edited by georgebid Loading

bjarnef commented Nov 6, 2023 • edited Loading

georgebid commented Nov 7, 2023 • edited Loading

bjarnef commented Nov 7, 2023

georgebid commented Nov 7, 2023 • edited Loading

bjarnef commented Nov 15, 2023

bjarnef commented Nov 15, 2023

Zeegaan commented Nov 16, 2023

bjarnef commented Nov 16, 2023

bjarnef commented Feb 19, 2024 • edited Loading

bjarnef commented Feb 21, 2024

Zeegaan commented Feb 22, 2024

bjarnef commented Feb 22, 2024 • edited Loading

Zeegaan left a comment

Choose a reason for hiding this comment

bjarnef commented Feb 23, 2024

Zeegaan commented Feb 23, 2024

bjarnef Feb 23, 2024

Choose a reason for hiding this comment

Zeegaan Feb 23, 2024

Choose a reason for hiding this comment

bjarnef Feb 23, 2024

Choose a reason for hiding this comment

bjarnef Feb 23, 2024

Choose a reason for hiding this comment

bjarnef Feb 23, 2024

Choose a reason for hiding this comment

Zeegaan Feb 26, 2024

Choose a reason for hiding this comment

Zeegaan commented Feb 26, 2024

bjarnef commented Feb 26, 2024

Zeegaan commented Feb 29, 2024

bjarnef commented Feb 29, 2024

bjarnef commented Nov 6, 2023 •

edited

Loading

github-actions bot commented Nov 6, 2023 •

edited by georgebid

Loading

bjarnef commented Nov 6, 2023 •

edited

Loading

georgebid commented Nov 7, 2023 •

edited

Loading

georgebid commented Nov 7, 2023 •

edited

Loading

bjarnef commented Feb 19, 2024 •

edited

Loading

bjarnef commented Feb 22, 2024 •

edited

Loading