# Webhooks (Notchset): prompt.md (v1.0.0)

- id: `webhooks` · version 1.0.0 · block · pro (Pro)
- category: Application UI
- build: Base UI (one set of files; its dependencies follow the build)
- install (this build): `npx shadcn@latest add @beautiful-ui-pro/webhooks`
- npm dependencies: class-variance-authority@^0.7
- registry dependencies: utils, https://beautiful-ui.dev/r/notchset-foundation.json
- docs: https://beautiful-ui.dev/components/webhooks
- The install command carries everything this item needs (files, CSS, tokens, npm and registry dependencies). Prefer it to copying source by hand.

A webhook console: endpoints with their events, a rolling delivery rate and a health tag; 24 hours of deliveries as 48 bars with failures in signal; recent deliveries with RETRY on failures; and an inspector with the response, the payload and the signed headers, numbered and copyable.

## Build it
- Stack: React 19 (`ref` is a plain prop), TypeScript, Tailwind CSS v4 utilities, a shadcn-initialised project with the `@/*` alias.
- Packages: `class-variance-authority@^0.7`.
- Files: `components/ui/notchset/blocks/webhooks.tsx`; shared code: `lib/beautiful-ui/notchset/instrument.tsx`, `lib/beautiful-ui/notchset/root.ts`, `lib/beautiful-ui/notchset/button-variants.ts`.
- Registry dependencies, installed with it automatically: shadcn `utils` (cn), `notchset-foundation`.
- Builds: one set of files for both, but its dependencies come in Base UI and Radix builds. Install the one that matches the project (see Install): a free item's bare URL installs the Base UI build of it and its dependencies.
- Exports to keep: `Webhooks`, and every exported type.
- CSS: the install adds the notchset foundation (tokens, keyframes, motion levels) to your global stylesheet once. Nothing to import by hand.
- Re-running `add` (or `--overwrite`) re-applies those rules: put overrides in your own CSS, never in the installed rules.
- Tokens: retheme with the `--notchset-*` custom properties (`--notchset-check`, `--notchset-control-edge`, `--notchset-draw-from`, `--notchset-ease-bloom`, `--notchset-ease-glide`, `--notchset-ease-key-down`, `--notchset-ease-key-up`, `--notchset-ease-travel`, `--notchset-fade`, `--notchset-focus-color`, `--notchset-focus-inset`, `--notchset-grow-to`, `--notchset-key-down`, `--notchset-key-up`, `--notchset-life-from`, `--notchset-life-ms`, `--notchset-node-blink`, `--notchset-node-bloom`, `--notchset-node-delay`, `--notchset-plate-color`, `--notchset-rise-from`, `--notchset-rule`, `--notchset-scan-to`, `--notchset-scroll`, `--notchset-signal`, `--notchset-sweep-to`, `--notchset-travel`). Never add Tailwind colour classes inside the component.

```tsx
import { Webhooks, type WebhookEndpoint } from "@/components/ui/notchset/blocks/webhooks";
```

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `Webhooks` | `webhooks` | Endpoints, the 24-hour chart, deliveries and the inspector. |

Style a part with `[data-slot="<slot>"]` selectors or its `className`; keep the attributes when editing.

## Sound
- Keep every `data-slot` and `data-sound` attribute: the sound layer reads them.
- Installing this item adds no audio. Nothing plays until the app mounts `SoundProvider` once (install: `npx shadcn@latest add https://beautiful-ui.dev/r/notchset-sound.json`, import from `@/components/ui/notchset/sound-provider`); `useSound()` gives `muted` and `setMuted` for a mute control. Without a provider the audio engine never loads.

## Match the original
- Read `components/ui/notchset/blocks/webhooks.tsx` as the reference implementation before changing or recreating anything, and match it: sizes, colours per theme, motion timings, copy and behaviour.
- If you deviate (a prop you can't honour, a style you changed, a dependency you swapped), say so in your reply, part by part.
- Keep the accessibility contract, the keyboard map and the motion levels listed below.

## Use it when
- webhooks, webhook endpoints, delivery log, retry deliveries, event delivery, payload inspector, developer settings, Notchset
- A developer settings page where customers manage webhook endpoints
- Debugging failed deliveries and retrying them

### Not when
- An audit log of user actions: use a Data Table
- Real-time event streams: use a live log view

## Mistakes
- Never send the full signing secret to the client: pass its last four characters
- Return the delivery's real new status from onRetry, so a retry that fails again stays failed

## Usage

```tsx
import { Webhooks, type WebhookEndpoint } from "@/components/ui/notchset/blocks/webhooks";

export function WebhookSettings({ endpoints }: { endpoints: WebhookEndpoint[] }) {
  return (
    <Webhooks
      endpoints={endpoints}
      onRetry={async (endpoint, delivery) => {
        const r = await fetch(`/api/webhooks/${endpoint.id}/deliveries/${delivery.id}/retry`, { method: "POST" });
        if (!r.ok) throw new Error("retry failed");
        return r.json();
      }}
      onSendTest={(endpoint) => fetch(`/api/webhooks/${endpoint.id}/test`, { method: "POST" })}
    />
  );
}
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `endpoints` | `{ id, name, url, events, secretSuffix, apiVersion?, total, buckets, deliveries }[]` |  | buckets are 48 half-hour counts, oldest first. Only the secret's last four characters reach the client. |
| `deliveries[]` | `{ id, event, status, duration, time, attempt, response, payload, headers, bucket? }` |  | status ≥ 400 counts as failing; bucket places a failure on the chart so a fixed retry clears it there. |
| `onRetry` | `(endpoint, delivery) => Promise<delivery>` |  | Re-send; resolve with the new state (a 2xx clears the failure everywhere), reject to keep it failed. |
| `onSendTest` | `(endpoint) => Promise` |  | Adds SEND TEST EVENT; resolving adds one to the 24-hour count. |
| `retryNote` | `string` |  | The note after the counts (default RETRIES FOR 3 DAYS). |

Full docs: https://beautiful-ui.dev/components/webhooks

## Customising
- Colours: the component reads your shadcn tokens (`--background`, `--foreground`, `--border` …), refined by the `--notchset-*` tokens. The signal colour is `--notchset-signal` (it falls back to `--destructive`). Set tokens on `:root`, or on any container to retheme one area.
- Dark mode follows the `.dark` class on an ancestor (the shadcn and next-themes convention).
- Update later by re-running the install with `--overwrite` (review the diff if you edited it). Changelog: https://beautiful-ui.dev/r/changelog.json

## Keyboard

| Keys | Action |
|---|---|
| Enter / Space | Select an endpoint (again: fold its deliveries) |
| ↑ ↓ | Move through recent deliveries |
| Tab | RETRY, COPY and the tabs |

## Performance

- 48 SVG bars and plain rows; nothing runs while idle.

## Responsive

- Under 640px (container width) each endpoint stacks its name, events and rate; the deliveries and the inspector stack under 680px.

## Motion inventory

| Interaction | What moves |
|---|---|
| Chart | Bars settle in, 6ms apart; a fixed failure drains from its bar |
| Retry | The scanner, then the status box turns to 200 and the counts roll |
| Deliveries | Unroll in 420ms and fold in 280ms |
| Endpoint | A 3px bar grows on the selected row |

## Accessibility contract (preserve when editing)
- Endpoints and deliveries are listboxes; the DELIVERIES header is a button with aria-expanded, and folded content is inert
- RETRY buttons are named with the event and time; the failing count is announced as it changes
- PAYLOAD and HEADERS are tabs over a focusable, scrollable code panel; the chart has a text label with the totals

## Install

```bash
npx shadcn@latest add @beautiful-ui-pro/webhooks
```

Pro item: needs the `@beautiful-ui-pro` registry in `components.json` and `BEAUTIFUL_UI_TOKEN` in `.env.local` (https://beautiful-ui.dev/account). Setup: https://beautiful-ui.dev/docs/pro. Your components.json `style` picks the build: radix-*, new-york and default get Radix, base-* gets Base UI.

## Credits
- Built on shadcn/ui (https://ui.shadcn.com)

The notchset foundation (the tokens listed above, keyframes and motion levels) installs once with the first component; its CSS is public at https://beautiful-ui.dev/r/notchset-foundation.json.