| Property | Description | Returns |
|---|---|---|
| type | Get the type of the event causing the hook execution. Always returns 'entity' for entity events. | string |
| dataDisplay | Get a string representation of this EntityBatchEvent's record | string |
| entityName | string | |
| method | string | |
| recordId | int | |
| record | Model | |
| preEventData | Get the data stored before the event occurs with the specified properties | array |
| typeDisplay | Get a string representation of the batch event based on its type | string |
| id | int | |
| created | Date the record was created. | DateTime |
| createdBy | Get the user that triggered the event | User |
| batch | Batch |
Hooks\Models\Api\EntityBatchEvent
Batch event containing information about which entity and record triggered a Hook and thus created a Batch