name | String. Name of the notifier. | ||
enabled | Boolean. Optional. Specifies whether the notifier is enabled or not. Set to: ![]() ![]() If a notifier is disabled, alerts are not fetched for the notifier. | ||
consumptionMode | String. Optional. Specifies whether notifications are created for all alerts or only the latest alerts. Set to: ![]() ![]() | ||
autoMark | Boolean. Optional. Specifies whether notifications are automatically marked as read or a user must do it manually. Set to: ![]() ![]() | ||
channelIds | Object[]. Identifies the channels for which you want to receive notifications. You can specify either an individual channel identifier or a list of identifiers. For example, channelIds[0] as 2 for "Server Error" or channelIds[1] as 10 for "Threat Protection" or channelIds[0] as 2 and channelIds[1] as 1 for both. | ||
intervalInSeconds | Short. Time in seconds after which the system task created for the notifier should check for unread alerts. | ||
severityCutoff | String. The severity to consider for fetching alerts. For example, if you set this value as Critical, you will receive notifications only for critical events. If you set this value as Error, you will receive notifications for critical and error events. Set the parameter to one of the following values: ![]() ![]() ![]() ![]() | ||
notifyInstantly | Boolean. Optional. Specifies whether or not notifications are generated as soon as an alert is raised. Set to: ![]() ![]() Note: If intervalInSeconds is also specified, the notifyInstantly parameter takes precedence. | ||
webSocketEnabled | Boolean. Optional. Specifies whether or not Integration Server uses a WebSocket connection to send notifications. Set to: ![]() ![]() | ||
webSocketSender | Document. Optional. Sends a message on a connected WebSocket session. | ||
Key | Description | ||
endPointURL | String. The URL of the remote WebSocket server that Integration Server uses to send notifications. | ||
serviceInvokeEnabled | Boolean. Optional. Specifies whether a service is invoked with the notifier parameters as pipeline variables or not. Set to: ![]() ![]() | ||
serviceInvokeSender | Document. Optional. Invokes a service for alerts fetched for this notifier. | ||
Key | Description | ||
nsName | String. The namespace of the service. For example, pub.flow:tracePipeline . | ||
smtpEnabled | Boolean. Optional. Specifies whether Integration Server uses an SMTP server to send notifications or not. Set to: ![]() ![]() | ||
smtpSender | Document. Optional. Details of the SMTP Server and client used to send the notifications. | ||
Key | Description | ||
to | String. E-mail address of the recipient for a notification. If you specify multiple addresses, separate them with commas. | ||
from | String. E-mail address of the sender. If you do not specify this value, Integration Server uses the value specified for the mail.smtp.from JVM property. Furthermore, if a value is not specified for that property, Integration Server uses the default value, user@servername, where the user is the operating system user ID, and servername is the host name of Integration Server. | ||
mailhost | String. Hostname of the SMTP server. | ||
mailhostPort | Integer. Optional. The port on which the SMTP server listens to incoming connections. | ||
auth | Document. Optional. Authorization information that the SMTP service submits to the SMTP server. | ||
Key | Description | ||
user | String. Username that Integration Server uses to send notifications. | ||
pass | String. Password associated with the user. | ||
secure | Document. Parameters specifying the security protocol and trust store information to perform certificate validation, which Integration Server uses to communicate with the SMTP server port. | ||
Key | Description | ||
transportLayerSecurity | String. Type of the security protocol that Integration Server uses to communicate with the SMTP server port. Set to: ![]() ![]() ![]() | ||
truststoreAlias | String. Alias for the truststore that contains the list of certificates that Integration Server uses to validate the trust relationship. If you do not specify a truststore alias, the default truststore alias is used. |
message | String. Indicates whether the notifier is successfully created or not. |