| Name | Type | Description | Notes |
|---|---|---|---|
| trigger_event | string | Trigger event type | |
| params | array<string,string> | Additional parameters that are specific to the chosen trigger event type. Please refer to the documentation for details. | [optional] |
| callback_handle | string | An arbitrary string that finAPI will include into the notifications that it sends based on this rule and that you can use to identify the notification in your application. For instance, you could include the identifier of the user that you create this rule for. Maximum allowed length of the string is 512 characters.<br/><br/>Note that for this parameter, you can pass the symbols '/', '=', '%' and '"' in addition to the symbols that are generally allowed in finAPI (see <a href='https://documentation.finapi.io/access/Allowed-Characters.2764767279.html' target='_blank'>Allowed Characters</a>). This was done to enable you to set Base64 encoded strings and JSON structures for the callback handle. | [optional] |
| include_details | bool | Whether the notification messages that will be sent based on this rule should contain encrypted detailed data or not. Default value is 'false'. | [optional] [default to false] |