Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[console] Support webhook on API update event #5426

Closed
phiz71 opened this issue Apr 14, 2021 · 2 comments
Closed

[console] Support webhook on API update event #5426

phiz71 opened this issue Apr 14, 2021 · 2 comments

Comments

@phiz71
Copy link
Member

phiz71 commented Apr 14, 2021

Global behavior

As a user, I want to be notified on API Update event.

Implementation plan

  1. We should add new events to subscribe for APIs.
    This events would be "API Updated" and "API Deployed" and would be emitted each time an API is updated or deployed. (TBD)

Capture d’écran 2021-04-14 à 15 47 46

  1. If the notifier is a webhook one, then the payload should be consistent with other events notification.
    (TBD: only for this new event or for all API events)

Testing scenario

  • Create an API
  • Add an alert on API Update event
  • Mail alert should be sent
  • Webhook call should same API info than others events.

You can use https://webhook.site/ to have a fake webhook

A real life example would be to integrate with a CI tool for example.

@aelamrani
Copy link
Member

👍🏼 but not sure it has to be added on the Lifecycle part

@RubenMMSantos
Copy link

RubenMMSantos commented Oct 21, 2021

Using the provided URL to check the webooks the following was covered:

  • - Created API
  • - Enabled alert on API Update/API Deployed event
  • - Performed actions across APIM to trigger both events
  • - Enabled custom templates for email notifications and triggered event
  • - Checked Audit for event logs and checked that events were correctly logged

@phiz71 phiz71 changed the title [management] Support webhook on API update event [console] Support webhook on API update event Nov 19, 2021
@phiz71 phiz71 closed this as completed Nov 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants