Files
HiveGrid-Wireframes/hivegrid-cloud/docs/milestones/M163-public-api-webhooks/PLAN.md
T

84 lines
3.9 KiB
Markdown

# M163 — Public-API: Webhooks (signiert, ein- und ausgehend)
**Block:** Block 7 · Modul 34
**Pflichtenheft-Quelle:** block7.md Abschnitt 34.2
## Ziel
Eingehende Webhooks (Lead-Push aus Web-Formularen): Slug-basiert mit 3 Auth-Optionen (API-Key, HMAC-Body, URL-Token mit Klartext-Warnung). Auto-Lead-Anlage mit Default-Tags + Duplikat-Check. Ausgehende Webhooks (Subscription-Modell): Event-Types (`contact.created`, `deal.stage_changed`, `project.completed`, `lead.qualified`). HMAC-SHA256 + Event-ID-Idempotenz. Retry exponentiell (1m/5m/30m/2h/12h, max 5x). Auto-Deaktivierung nach 10 fehl-Auslieferungen. Test-Funktion. Statistik letzte 100 Auslieferungen. Allgemeine Event-Ingestion `POST /api/v1/integrations/events` für Automation-Trigger.
## Pflichtenheft-Bezug
- 34.2 — Webhooks (alle Punkte)
## Abhängigkeiten
- **Vorbedingung:** M161, M162, M007 (Idempotenz), M075 (Automation für Event-Trigger)
- **Wird benötigt von:** Drittanbieter-Integration
## Out of Scope
- Webhook-Replay-Tool im UI → Phase 2 (34.X.5)
## Erfolgskriterium
Form-Anbieter pusht via signiertem Webhook → Lead landet in Inbox; Subscription „deal.stage_changed" liefert HMAC-signiert mit Retry bei 5xx; 10. Fehl-Auslieferung deaktiviert Subscription.
## Hinweise für Slice-Planung
- BullMQ-Job pro Webhook-Versand mit Backoff
- HMAC-Verify als Middleware
---
## Definition of Done — verbindlich (siehe `AGENTS.md` + `docs/INTEGRATION-CONTRACTS.md`)
Dieses Milestone gilt **nur dann als erledigt**, wenn alle Punkte wahr sind. Bei Verstoß: PR-Block.
### Erreichbarkeit
- [ ] **Sidebar-Eintrag** in `packages/ui-hivegrid/src/app-shell/sidebar.config.ts` mit Permission-Gate (oder explizit dokumentiert, warum nur Inline-Verlinkung) — Gruppe gemäß `docs/INTEGRATION-CONTRACTS.md` §1
- [ ] **Route** unter korrektem URL-Pattern (INTEGRATION-CONTRACTS §3)
- [ ] **Breadcrumb** für Detail-Routes (§4)
- [ ] **Mobile-Tab-Bar-Eintrag** falls mobile-relevant (§13)
- [ ] **Customer-Portal-Sichtbarkeit** explizit konfiguriert (§14)
### Querschnitt-Wiring
- [ ] **Audit** läuft (auto via M001 oder manuell)
- [ ] **Activity-Stream** via `logActivity` bei relevanter Aktion (M045)
- [ ] **Notifications** via `notify()` (M011), nicht direkt
- [ ] **Search-Index** registriert in `indexed-entities.ts`, falls suchbar
- [ ] **Permission-Filter** via `withTenantScope()` + `withPermission()` (M004)
- [ ] **Feature-Flag-fähig** (M006) — Modul ohne Deploy abschaltbar
### Code-Layer-Disziplin (PR-Block)
- [ ] Loader baut View-Model; UI-Component empfängt nur VM + Actions
- [ ] Keine Prisma-/Server-Imports in `packages/ui-hivegrid/**`
- [ ] Subframe-Output via Adapter, nicht direkt importiert
- [ ] Alle UI-Texte als i18n-Keys (M003-Build-Lint blockt sonst)
### Tests
- [ ] **Unit-Test** für VM-Builder mit Zod-Schema-Validierung
- [ ] **Smoke-Test** `e2e/smoke/<modul>.spec.ts` (Login → Route → Hauptaktion → erwartetes UI)
- [ ] **Hot-Swap-Drill** grün (Smoke-Test gegen `packages/ui-mock` aus M017)
- [ ] **Visual-Regression-Snapshot** der Hauptansicht (M016)
### Klartext (User-facing)
- [ ] Fehler-Texte aus M002-Catalog (kein HTTP-Code im UI)
- [ ] Empty-State mit Klartext + nächster Aktion
- [ ] Loading-State mit Klartext (kein leerer Spinner)
- [ ] Permission-Denied → 404, nicht 403 (Bauprinzip A.5.3)
### Rollback-Pfad
- [ ] **Forward-Only-DB-Migration** mit Inverse-SQL als Kommentar
- [ ] **Atomic-Slice-Commits** (TC-Default)
- [ ] **Feature-Flag** vorhanden, um das Modul ohne Deploy auszuschalten
---
## Klick-Pfad zum Prüfen (für User)
Wenn dieses Milestone fertig ist, prüft der User die Funktion über folgenden Pfad:
1. Login als geeigneter User-Typ (siehe Erfolgskriterium oben)
2. Sidebar-Gruppe + Eintrag öffnen (gemäß INTEGRATION-CONTRACTS.md §1)
3. Hauptaktion ausführen
4. Erwartetes Ergebnis sichtbar (siehe Erfolgskriterium)
**Falls etwas nicht erreichbar ist:** Milestone ist trotz „grüner Tests" nicht fertig — siehe Erreichbarkeits-Checkliste oben.