Frontend | Backend | Api

Hooks\Models\Api\ScheduledBatchEvent

Batch event containing information about which task triggered the event

Property Description Returns
type Get the type of the event causing the hook execution. Always returns 'scheduled' for scheduled events. string
task Return the task that triggered this hook Task
typeDisplay Get a string representation of the batch event based on its type string
dataDisplay Get a string representation of additional batch event source data for the table. Empty by default. string
id int
created Date the record was created. DateTime
createdBy Get the user that triggered the event User
batch Batch