LendingAppSettings

Describes settings for a lending app.

Field	Data Type	Description
services[]	AppServiceStatus	Required Status settings for lending app services. Read-write
webhooks[]	AppWebhook	Required Lending app webhooks. Read-write
messages[]	AppMessage	Required Configured messages meant to be consumed by app users. Read-write
locale	Locale | null	Required App locale settings. You are heavily encouraged to set this to avoid timezone, language and currency issues. Read-write
custom	map( key:string, value:string|number|boolean|null ) | null	Required Custom app settings. Note that the object should only contain primitive values. Nested objects are not allowed. If you need to set an object as a value, make sure to serialize it to a string first. The object should not exceed 5 MB in size. Read-write

AppServiceStatus

Describes the status of an app service.

Field	Data Type	Description
kind	string	Required Service kind. Read-only-after-creation
enabled	boolean	Required Denotes whether service is enabled. Read-write
message	string | null	Required The service status message to be displayed to app users. Read-write

AppWebhook

Describes an app webhook.

Field	Data Type	Description
kind	string	Required Webhook kind. Read-only-after-creation
url	string	Required Webhook HTTP/HTTPS URL. It should be a POST method. Read-write
headers	map(key:string,value:string)	Required Custom webhook request headers such as authorization tokens. Read-write
authentication	map(key:string,value:string) | null	Required Basic authentication settings. Set to null if you do not use basic authentication else, it must contain a username and a password. For example. { 'username': 'user', 'password': 'pass' } Read-write
timeout	number | null	Required Request timeout in seconds. A null value indicates no timeout. Read-write
response	map(key:string,value:string) | null	Required Expected webhook response settings. The fields within this object are described below. content (string): Content to be matched in response data. validation (contains | matches ): Content validation strategy. contains searches for a sub string within the response data while matches searches for an exact match. Defaults to contains when the response setting is set to null. Read-write

AppMessage

Describes a custom message meant to be consumed by users on the app.

Field	Data Type	Description
messageId	string	Required Unique message identifier Read-only-after-creation
messageType	string ( 'info', 'warning', 'success', 'failure', 'error' )	Required Message type. Read-write
body	string	Required Message body. Read-write
tags	map(key:string,value:string|number|boolean) | null	Required Message tags. Read-write