Type Alias HookInput

HookInput: {
    entity: string;
    hookArgs: any[];
    hookEntity: string;
    id: string;
    options?: Partial<HookOptions>;
}

Hook function inputs. Hooks augment running jobs.

Type declaration

entity: string
The target function's entity identifier
Example
```
'user'
```
hookArgs: any[]
The hook function's input arguments
Example
```
'notify'
```
hookEntity: string
The hook function's entity identifier
Example
```
'user.notify'
```
id: string
The target execution id (workflowId/jobId)
Example
```
'jsmith123'
```
Optionaloptions?: Partial<HookOptions>
Extended options for the hook function, like specifying a taskQueue
Example
```
{ taskQueue: 'priority' }
```