InlineNotificationWatcher1

JSON Example

{
    "authentication_scheme": {
        "certificate_id": "string",
        "password": "string",
        "scheme_name": "string",
        "username": "string"
    },
    "certificate_sha256_thumbprint": "string",
    "description": "string",
    "id": "string",
    "max_send_uri_count": 0,
    "method": "string",
    "port": 0,
    "send_interval": 0,
    "send_timeout": 0,
    "server": "string",
    "uri": "string",
    "use_https": false
}

NotificationAuthenticationScheme

authentication_scheme

Required

NotificationAuthenticationScheme describes how notification requests should authenticate to the server.

string

certificate_sha256_thumbprint

Optional

Contains the hex-encoded SHA256 thumbprint of the HTTPS certificate. It must be specified if use_https is set to true.

string

description

Optional

Optional description that can be associated with this NotificationWatcher.

string

Optional

System generated identifier to identify a notification watcher uniquely.

integer As int64 As int64

max_send_uri_count

Optional

Constraints: minimum: 1 maximum: 5000 default: 5000

If the number of notification URIs accumulated in specified send_interval exceeds max_send_uri_count, then multiple notification requests (each with max_send_uri_count or less number of notification URIs) will be sent to this NotificationWatcher. The default value is 5000.

string

method

Required

Type of method notification requests should be made on the specified server. The value must be set to POST.

integer As int64 As int64

port

Optional

Constraints: minimum: 0 maximum: 65535

Optional integer port value to specify a non-standard HTTP or HTTPS port.

integer As int64 As int64

send_interval

Optional

Constraints: minimum: 30

Optional time interval (in seconds) for which notification URIs will be accumulated. At the end of the time interval the accumulated notification URIs will be sent to this NotificationWatcher in the form of zero (nothing accumulated) or more notification requests as soon as possible. If it is not specified, the NotificationWatcher should expected to receive notifications at any time.

integer As int64 As int64

send_timeout

Optional

Constraints: minimum: 1 default: 30

Optional time duration (in seconds) to specify request timeout to notification watcher. If the send reaches the timeout, will try to send refresh_needed as true in the next time interval. The default value is 30 seconds.

string

server

Required

IP address or fully qualified domain name of the partner/customer watcher.

string

uri

Required

URI notification requests should be made on the specified server.

boolean

use_https

Optional

Optional field, when set to true indicates REST API server should use HTTPS.

Used By

NotificationWatcher