| Property | Description | Returns |
|---|---|---|
| type | Get the type of the event causing the hook execution. Always returns 'web' for web events. | string |
| dataDisplay | Get a string representation the source hook and action for this batch event | string |
| webEvent | Get the web event that triggered this batch | WebEvent |
| queryParameters | Get the query parameters for the called web event | array |
| pathParameters | Get the path parameters (e.g. everything after the slug, seperated by slash) from the called event | array |
| headers | Get the headers sent with the call to the web event | array |
| body | Get the body sent with the call to the web event | string |
| contentType | Get the content type from the web event call | string |
| bodyData | Get the body data for this web event call with content-type was application/json. Returns the data in array form if it was submitted as JSON or Form encoded. | ReadOnlyCollection |
| method | Get the HTTP method used when calling the web event | string |
| 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\WebBatchEvent
Batch event containing information about the web event that issued the hook