Skip to content

Initial Webhook Designs #2814

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

Open
benjaminleonard opened this issue May 1, 2025 · 1 comment
Open

Initial Webhook Designs #2814

benjaminleonard opened this issue May 1, 2025 · 1 comment
Assignees
Labels
design Requires design input

Comments

@benjaminleonard
Copy link
Contributor

Based on the wonderful work by @hawkw here: oxidecomputer/omicron#7277

--

Included is:

  • Top-level webhooks index page
  • Create new webhook receiver page
  • Webhook details page
  • Webhook delivery details pane

Note the deliver pane includes information that is currently not passed through the API, but I do think it would be useful for debugging. That is the event payload and headers. There's perhaps some discussion needed around the permissions model for that aka does the person viewing the webhook also have the requisite permission to view the contents of the event payload?

Included a developer tab; for both the webhook test probe event and information in the signature format. I think it's useful to bring especially relevant docs directly into the console like this, still linking out to the full guide.

I'm introducing a variant of the mini table here, it's going to be especially useful on the firewall rules pane, since it lets the user add items to the array without needing another dialog or the issue of the user not realising they need to save / add their input. I have some changes to the original mini table component also to unify the inline and external input variants. Will follow up with that separately.

The event subscriptions input on the create page lets the user use both checkboxes and inputs to add subscriptions. What this means is the event catalog is very discoverable, and quick to select, but also maintains the powerful event glob UX with a regular text input. Will include a GIF of this prototyped. The add event only takes a single string, so we can't reuse this in the modal. We might consider modifying the API to accept an array of event classes here also.

I wouldn't focus too heavily on the text right now, I haven't really dug into it and am focusing on the flow since I think @david-crespo wants to prod at some of the labels.

--

Comment here: https://app.workflow.design/w/doc/6a1ec7a1-cf86-4885-aaf0-3d039f67b79c

@benjaminleonard
Copy link
Contributor Author

Older design, but you get an idea of the dual event subscription input.

Image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
design Requires design input
Projects
None yet
Development

No branches or pull requests

5 participants