NotificationDto Data Type

The Class NotificationDto.

Abstract Type
Subtypes
WebHookDto, ScriptNotificationDto, EmailNotificationDto, JobTriggerDto
Implemented Interfaces
Serializable
Properties
name data type constraints description
disabled boolean   Is entity disabled. Value is ignored in Update action - use enable/disable API instead.
id number   The id.
auditableField array of AuditableFieldDto  
classNameFilter string   The class name filter.
code string required The code
eventTypeFilter NotificationEventTypeEnum   Valid values: CREATED, UPDATED, REMOVED, TERMINATED, DISABLED, PROCESSED, REJECTED, REJECTED_CDR, LOGGED_IN, INBOUND_REQ, ENABLED
description string   The description
elFilter string   The el filter.
updatedCode string   The updated code.
scriptInstanceCode string   The script instance code.
scriptParams map of string   The script params.
counterTemplate string   The counter template.
priority number   The priority.
active boolean   Is Notification active. A negative of Disabled. Deprecated in 5.0.1. Use Disabled field instead.
runAsync boolean   Whether this notification will be run in async mode.
saveSuccessfulNotifications boolean   Whether this notification will be persisted when successful.

Example

This data type is abstract. The example below may be incomplete. More accurate examples can be found in subtypes pages.
{
  "disabled" : true,
  "id" : 12345,
  "auditableField" : [ {
    "entityClass" : "...",
    "fieldName" : "...",
    "id" : 12345,
    "changeOrigin" : "...",
    "auditableField" : [ { }, { } ],
    "originName" : "...",
    "code" : "...",
    "previousState" : "...",
    "currentState" : "...",
    "description" : "...",
    "created" : "...",
    "updatedCode" : "...",
    "actor" : "..."
  }, {
    "entityClass" : "...",
    "fieldName" : "...",
    "id" : 12345,
    "changeOrigin" : "...",
    "auditableField" : [ { }, { } ],
    "originName" : "...",
    "code" : "...",
    "previousState" : "...",
    "currentState" : "...",
    "description" : "...",
    "created" : "...",
    "updatedCode" : "...",
    "actor" : "..."
  } ],
  "classNameFilter" : "...",
  "code" : "...",
  "eventTypeFilter" : "PAYMENT_STATUS_UPDATED",
  "description" : "...",
  "elFilter" : "...",
  "updatedCode" : "...",
  "scriptInstanceCode" : "...",
  "scriptParams" : {
    "property1" : "...",
    "property2" : "..."
  },
  "counterTemplate" : "...",
  "priority" : 12345,
  "runAsync" : true,
  "saveSuccessfulNotifications" : true
}