Actor Lifecycle Hooks

Actor lifecycle hooks are rule events that fire at specific points in an actor's lifecycle. They allow you to validate operations, enforce business logic, and trigger automations tied to actor state changes.

Hook Timing

Hooks are organized by when they execute relative to the operation.

Before Hooks

Execute before the operation completes — can prevent it with a validation error:

• OnOrderBeforeCreated — Before order is created
• OnOrderBeforeDeleted — Before order is deleted
• OnPaymentBeforeCreated — Before payment is created
• OnPaymentBeforeDeleted — Before payment is deleted
• OnTicketBeforeCreated — Before ticket is created
• OnTicketBeforeDeleted — Before ticket is deleted
• OnSkuBeforeCreated — Before SKU is created
• OnSkuBeforeDeleted — Before SKU is deleted
• OnAssetBeforeCreated — Before asset is created
• OnAssetBeforeDeleted — Before asset is deleted

Use for: Validation, preventing invalid state

After Hooks

Execute after the operation completes — changes are persisted:

• OnOrderCreated — After order is created
• OnOrderDeleted — After order is deleted
• OnPaymentCreated — After payment is created
• OnPaymentDeleted — After payment is deleted
• OnPaymentCapture — After payment is captured
• OnTicketCreated — After ticket is created
• OnTicketDeleted — After ticket is deleted
• OnTicketComplete — After ticket is completed
• OnTicketRejected — After ticket is rejected
• OnSkuCreated — After SKU is created
• OnSkuDeleted — After SKU is deleted
• OnAssetCreated — After asset is created
• OnAssetDeleted — After asset is deleted

Use for: Automation, notifications, integrations

Command Hooks

Execute when commands are applied to an actor:

• OnOrderCommands — When commands applied to order
• OnPaymentCommands — When commands applied to payment
• OnTicketCommands — When commands applied to ticket
• OnSkuCommands — When commands applied to SKU
• OnAssetCommands — When commands applied to asset

Use for: Cascading logic, deriving additional changes

Journal Hooks

Execute when journal entries are created:

• OnOrderJournal — When order journal entry created
• OnPaymentJournal — When payment journal entry created

Use for: Audit trail reactions, logging

Hooks by Actor Type

Order (6 hooks)

• OnOrderBeforeCreated
• OnOrderCreated
• OnOrderBeforeDeleted
• OnOrderDeleted
• OnOrderCommands
• OnOrderJournal

Payment (7 hooks)

• OnPaymentBeforeCreated
• OnPaymentCreated
• OnPaymentBeforeDeleted
• OnPaymentDeleted
• OnPaymentCommands
• OnPaymentCapture
• OnPaymentJournal

Ticket (8 hooks)

• OnTicketBeforeCreated
• OnTicketCreated
• OnTicketBeforeDeleted
• OnTicketDeleted
• OnTicketCommands
• OnTicketComplete
• OnTicketRejected

SKU (5 hooks)

• OnSkuBeforeCreated
• OnSkuCreated
• OnSkuBeforeDeleted
• OnSkuDeleted
• OnSkuCommands

Asset (5 hooks)

• OnAssetBeforeCreated
• OnAssetCreated
• OnAssetBeforeDeleted
• OnAssetDeleted
• OnAssetCommands

Execution Order

For a single actor operation, hooks execute in this sequence:

1. Before hooks — can prevent the operation with a validation error
2. Operation executes — entity created, commands applied
3. Commands hooks — can add further commands
4. Created/Deleted hooks — automation and notifications
5. Journal hooks — if a journal entry was created

Example for creating an order:

1. OnOrderBeforeCreated — Validate the order
2. Order created in database
3. OnOrderCreated — Send confirmation email
4. OnOrderJournal — Log journal entry (if created)

Choosing the Right Hook

Use Before hooks when:

• Validating input before operations complete
• Preventing invalid state changes
• Checking business rule constraints

Use After hooks when:

• Sending notifications
• Triggering external integrations
• Creating related entities
• Scheduling follow-up work

Use Command hooks when:

• Deriving additional changes from commands
• Applying cascading updates
• Enforcing command combinations

Examples

Validation with a Before Hook

param input: OnOrderBeforeCreated

let hasValidDelivery = input.order.deliveries count > 0

from hasValidDelivery match
  false |> {
    effect = 'validationError'
    code = 'NO_DELIVERY'
    message = 'Order must have at least one delivery'
  }

Automation with an After Hook

param input: OnTicketComplete

from {
  effect = 'messageActor'
  actorType = 'order'
  actorId = input.ticket.orderId
  messages = [{
    type = 'applyCommands'
    body = {
      commands = [{
        type = 'addTag'
        value = 'support-resolved'
      }]
    }
  }]
}

Cascading with a Command Hook

param input: OnOrderCommands

let hasCancellation = input.order.commands
  any c => c.type = 'cancel'

from hasCancellation match
  true |> {
    effect = 'orderCommand'
    type = 'addTag'
    value = 'cancelled'
  }

See Also

• Rule Hooks — Overview of all hook families
• Rule Effects — Available effects
• Common Patterns — Recipe-style examples
• Runtime Reference — Detailed hook documentation