WebHookDto Data Type

The Class WebHookDto.

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  
httpProtocol HttpProtocol   The http protocol.
classNameFilter string   The class name filter.
host string   The host.
code string required The code
port number   The port.
page string   The page.
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.
httpMethod WebHookMethodEnum   Valid values: HTTP_GET, HTTP_POST, HTTP_PUT, HTTP_DELETE.
updatedCode string   The updated code.
scriptInstanceCode string   The script instance code.
username string   The username.
scriptParams map of string   The script params.
password string   The password.
counterTemplate string   The counter template.
headers map of string   The headers.
priority number   The priority.
params map of string   The params.
active boolean   Is Notification active. A negative of Disabled. Deprecated in 5.0.1. Use Disabled field instead.
bodyEl string   El Expression for the body
runAsync boolean   Whether this notification will be run in async mode.
saveSuccessfulNotifications boolean   Whether this notification will be persisted when successful.

Example

{
  "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" : "..."
  } ],
  "httpProtocol" : "HTTP",
  "classNameFilter" : "...",
  "host" : "...",
  "code" : "...",
  "port" : 12345,
  "page" : "...",
  "eventTypeFilter" : "ADVT_RATE_INCREASED",
  "description" : "...",
  "elFilter" : "...",
  "httpMethod" : "HTTP_GET",
  "updatedCode" : "...",
  "scriptInstanceCode" : "...",
  "username" : "...",
  "scriptParams" : {
    "property1" : "...",
    "property2" : "..."
  },
  "password" : "...",
  "counterTemplate" : "...",
  "headers" : {
    "property1" : "...",
    "property2" : "..."
  },
  "priority" : 12345,
  "params" : {
    "property1" : "...",
    "property2" : "..."
  },
  "bodyEl" : "...",
  "runAsync" : true,
  "saveSuccessfulNotifications" : true
}