Skip to content

Latest commit

 

History

History
executable file
·
13 lines (9 loc) · 1.46 KB

NotificationRuleParams.md

File metadata and controls

executable file
·
13 lines (9 loc) · 1.46 KB

NotificationRuleParams

Properties

Name Type Description Notes
TriggerEvent string Trigger event type [default to null]
Params map[string]string Additional parameters that are specific to the chosen trigger event type. Please refer to the documentation for details. [optional] [default to null]
CallbackHandle 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 '&quot;' in addition to the symbols that are generally allowed in finAPI (see https://finapi.zendesk.com/hc/en-us/articles/222013148). This was done to enable you to set Base64 encoded strings and JSON structures for the callback handle. [optional] [default to null]
IncludeDetails bool Whether the notification messages that will be sent based on this rule should contain encrypted detailed data or not [optional] [default to null]

[Back to Model list] [Back to API list] [Back to README]