g
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 Gets a string representation of the batch event based on its type string
recordDisplay Gets a string representation of the batch event record. By default, there is no record. string
id int
created Date the record was created. DateTime
batch Batch