@@ -5,37 +5,6 @@ description: Webhook protocol schemas
55
66{ /* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */ }
77
8- Webhook Trigger Event
9- When should this webhook fire?
10-
11- These mirror the record events the engine actually emits
12- (` data.record.created ` / ` updated ` / ` deleted ` ), which the webhook
13- auto-enqueuer maps to ` create ` / ` update ` / ` delete ` . Only events with a real
14- producer are declared here — an author can't subscribe to something that
15- never fires.
16-
17- ** Bulk triggers (#4639 ).** ` bulk_update ` / ` bulk_delete ` map to the engine's
18- aggregate ` data.records.updated ` / ` data.records.deleted ` , emitted when a
19- predicate write (` multi: true ` → ` IDataDriver.updateMany ` /` deleteMany ` )
20- affects a set of rows the driver reports only as a count. They are separate
21- trigger values, not extra sources for ` update ` / ` delete ` , because their
22- delivery has a different SHAPE: no ` recordId ` , no record body, just
23- ` object ` + ` matched ` . Folding them into the per-record triggers would send
24- every existing subscriber a body missing the fields it reads — the same
25- class of breakage as the pre- #4626 ` recordId: '' ` fabrication, arriving from
26- the other direction. A webhook that wants both subscribes to both.
27-
28- Deliberately NOT triggers (#3196 ):
29- - ` undelete ` — there is no soft-delete / restore capability in the engine
30- (` delete ` is a hard delete; no ` deleted_at ` convention, no restore
31- operation, no ` data.record.undeleted ` emit), so it had no event source.
32- Reintroduce it only alongside a real restore subsystem that emits an
33- undelete event.
34- - ` api ` (manual/programmatic fire) — no manual fire path exists (the only
35- webhook HTTP surface re-queues already-failed deliveries). Reintroduce it
36- with a real "fire this webhook now" endpoint/service, not as a bare enum
37- value that silently never fires.
38-
398<Callout type = " info" >
409** Source:** ` packages/spec/src/automation/webhook.zod.ts `
4110</Callout >
0 commit comments