entities.hooks

Refused at apply

JSONata — JSONata transformations are not evaluated yet: the action still runs, but with Alvo’s canonical event envelope as its body instead of the transformation declared here — a delivery that succeeded carrying data you did not declare, which is indistinguishable from a bug in the consumer. Fix: Use a ’{{…}}’ template instead (e.g. “{{new.title}}”), which this build does render, or remove the transformation and accept the canonical envelope. A partial JSONata implementation is deliberately not offered: silently producing a different payload for the part it does not implement costs more than this refusal. Tracked in #149.

email.data — An ‘email’ action’s ‘data’ is not rendered: it is validated when the descriptor is applied and then read by nothing, so the mail goes out with the referenced template’s own subject and body and the values declared here are silently dropped — a message that was delivered without the data you declared, which is indistinguishable from a template bug. Fix: Move the values into the template’s ‘subject’/‘body’ as ’{{…}}’ placeholders over ‘new’/‘old’/‘event’/‘@user.id’, which this build does render, or remove ‘data’. A ‘data.*’ placeholder root is new surface and lands with the PR that reads it.

function — The ‘function’ action is declared in the schema but not implemented in this build, so this hook invokes nothing — no function declared under ‘functions’ runs, on this hook or on any trigger or schedule it declares elsewhere. Fix: Use a ‘webhook’ or ‘email’ action, which this build does run. Custom functions are planned and the schema freezes their shape ahead of the implementation.

http.call — The ‘http.call’ action is declared in the schema but not implemented in this build, so this hook makes no request: the URL is never called, and ‘headersSecretRef’ is never read, so a receiver you believe is being notified is not. Fix: Declare the target under ‘webhooks.endpoints’ and use a ‘webhook’ action instead — that is the managed path, and it is the one this build delivers on.

entity.update — The ‘entity.update’ action is declared in the schema but not implemented in this build, so this hook writes nothing — no record is written or patched on the target entity, and no event is emitted for the write that did not happen. Fix: Perform the follow-up write through the Data API for now. ‘entity.update’ lands with automation, where the causation chain it creates can be bounded.

Guide: Before-hooks

The entities block spans these pages: entities · entities · fields · entities · computed & rollups · entities · rules · entities · hooks · entities · indexes.

Keys

entities.<name>.hooks

Lifecycle hooks. before* = in-transaction, no network, may reject/mutate; after* = post-commit from the outbox.

• Type: object
• Required: no

entities.<name>.hooks.beforeCreate

Before-hooks, run in declaration order inside the write’s transaction: each may reject the write or mutate the row about to be written (mutate is refused on beforeDelete). No network access.

• Type: array of object
• Required: no

entities.<name>.hooks.beforeCreate[].condition

Condition in the CEL subset. Context: @user, @tenant; hooks/events additionally expose old, new, changed(field). Compiled fail-fast at apply time.

• Type: string
• Required: no

entities.<name>.hooks.beforeCreate[].action

Before-actions run in-transaction: reject or mutate only. No network, no external calls.

• Type: object
• Required: yes

entities.<name>.hooks.beforeCreate[].action.reject

Cancels the operation; the text becomes the detail of the RFC 7807 error.

• Type: string
• Required: yes (in its variant)
• Exactly one of reject, mutate.

entities.<name>.hooks.beforeCreate[].action.mutate

Payload patch before write: field -> literal value or tagged {“$cel”: ”…”} expression.

• Type: map of any
• Required: yes (in its variant)
• Exactly one of reject, mutate.
• Each entry: A literal JSON value, or a tagged CEL expression object {“$cel”: ”…”}.

entities.<name>.hooks.beforeCreate[].action.mutate.<name>.$cel

A CEL expression whose result becomes the value, in place of a JSON literal (e.g. now(), @user.id).

• Type: string
• Required: yes

entities.<name>.hooks.beforeUpdate

Before-hooks, run in declaration order inside the write’s transaction: each may reject the write or mutate the row about to be written (mutate is refused on beforeDelete). No network access.

• Type: array of object
• Required: no
• Same shape as entities.<name>.hooks.beforeCreate.

entities.<name>.hooks.beforeDelete

Before-hooks, run in declaration order inside the write’s transaction: each may reject the write or mutate the row about to be written (mutate is refused on beforeDelete). No network access.

• Type: array of object
• Required: no
• Same shape as entities.<name>.hooks.beforeCreate.

entities.<name>.hooks.afterCreate

After-hooks, delivered post-commit from the outbox with retries; a condition filters which writes trigger them.

• Type: array of object
• Required: no

entities.<name>.hooks.afterCreate[].condition

Condition in the CEL subset. Context: @user, @tenant; hooks/events additionally expose old, new, changed(field). Compiled fail-fast at apply time.

• Type: string
• Required: no

entities.<name>.hooks.afterCreate[].action

After-side action (post-commit, durable, retries). Payload transformations = JSONata; {{…}} is sugar.

• Type: object
• Required: yes

entities.<name>.hooks.afterCreate[].action.type

Selects the variant.

• Type: string
• Required: yes
• Values: "webhook", "email", "function", "entity.update", "http.call"

entities.<name>.hooks.afterCreate[].action.endpoint

The name of an endpoint declared under the top-level webhooks.endpoints.

• Type: string
• Required: yes (in its variant)
• Pattern: ^[a-z][a-z0-9_-]{0,62}$
• Only when type is "webhook".

entities.<name>.hooks.afterCreate[].action.payload

Depends on the variant; see the notes below.

• Type: string or map of any
• Required: depends on the variant
• Only when type is "webhook", "entity.update" or "http.call".
• When type is "webhook" or "http.call": string, optional — JSONata transformation expression (JSON -> JSON). Runs strictly post-commit (after-side), with depth/time limits. {{…}} templates are syntactic sugar.
• When type is "entity.update": map of any, required — Field -> literal value or tagged {“$cel”: ”…”} expression; {{…}} sugar allowed in string values. Each entry: A literal JSON value, or a tagged CEL expression object {“$cel”: ”…”}.
• When type is "entity.update": Same shape as entities.<name>.hooks.beforeCreate[].action.mutate.<name>.

entities.<name>.hooks.afterCreate[].action.template

The name of a template declared in the top-level templates block.

• Type: string
• Required: yes (in its variant)
• Pattern: ^[a-z][a-z0-9_-]{0,62}$
• Only when type is "email".

entities.<name>.hooks.afterCreate[].action.to

Address or a {{…}} template.

• Type: string
• Required: yes (in its variant)
• Only when type is "email".

entities.<name>.hooks.afterCreate[].action.data

JSONata transformation expression (JSON -> JSON). Runs strictly post-commit (after-side), with depth/time limits. {{…}} templates are syntactic sugar.

• Type: string
• Required: no
• Only when type is "email".

entities.<name>.hooks.afterCreate[].action.name

The name of a function declared in the top-level functions block.

• Type: string
• Required: yes (in its variant)
• Pattern: ^[a-z][a-z0-9_-]{0,62}$
• Only when type is "function".

entities.<name>.hooks.afterCreate[].action.input

JSONata transformation expression (JSON -> JSON). Runs strictly post-commit (after-side), with depth/time limits. {{…}} templates are syntactic sugar.

• Type: string
• Required: no
• Only when type is "function".

entities.<name>.hooks.afterCreate[].action.entity

The entity whose record is created or updated.

• Type: string
• Required: yes (in its variant)
• Pattern: ^[a-z][a-z0-9_-]{0,62}$
• Only when type is "entity.update".

entities.<name>.hooks.afterCreate[].action.recordId

Id or {{…}} template; omit to create a new record.

• Type: string
• Required: no
• Only when type is "entity.update".

entities.<name>.hooks.afterCreate[].action.url

Absolute URL to call.

• Type: string
• Required: yes (in its variant)
• Only when type is "http.call".

entities.<name>.hooks.afterCreate[].action.method

HTTP method.

• Type: string
• Required: no
• Values: "GET", "POST", "PUT", "PATCH", "DELETE"
• Default: "POST"
• Only when type is "http.call".

entities.<name>.hooks.afterCreate[].action.headersSecretRef

Secret name in ISecretStore holding request headers (e.g. auth token); never the value itself.

• Type: string
• Required: no
• Only when type is "http.call".

entities.<name>.hooks.afterUpdate

After-hooks, delivered post-commit from the outbox with retries; a condition filters which writes trigger them.

• Type: array of object
• Required: no
• Same shape as entities.<name>.hooks.afterCreate.

entities.<name>.hooks.afterDelete

After-hooks, delivered post-commit from the outbox with retries; a condition filters which writes trigger them.

• Type: array of object
• Required: no
• Same shape as entities.<name>.hooks.afterCreate.