The Class WebHookDto.
| name | data type | type | namespace | min/max occurs | constraints | description |
|---|---|---|---|---|---|---|
| headers | (custom) | element | 0/1 | The headers. | ||
| host | string | element | 1/1 | required | The host. | |
| httpMethod | webHookMethodEnum | element | 1/1 | required | Valid values: HTTP_GET, HTTP_POST, HTTP_PUT, HTTP_DELETE. | |
| httpProtocol | httpProtocol | element | 0/1 | The http protocol. | ||
| page | string | element | 1/1 | required | The page. | |
| params | (custom) | element | 0/1 | The params. | ||
| password | string | element | 0/1 | The password. | ||
| port | int | element | 1/1 | required | The port. | |
| username | string | element | 0/1 | The username. | ||
Properties inherited from notificationDto |
||||||
| active | boolean | element | 0/1 | Is Notification active. A negative of Disabled. Deprecated in 5.0.1. Use Disabled field instead. | ||
| classNameFilter | string | element | 1/1 | required | The class name filter. | |
| counterTemplate | string | element | 0/1 | The counter template. | ||
| elFilter | string | element | 0/1 | The el filter. | ||
| eventTypeFilter | notificationEventTypeEnum | element | 1/1 | required | Valid values: CREATED, UPDATED, REMOVED, TERMINATED, DISABLED, PROCESSED, REJECTED, REJECTED_CDR, LOGGED_IN, INBOUND_REQ, ENABLED | |
| priority | int | element | 1/1 | The priority. | ||
| runAsync | boolean | element | 0/1 | Whether this notification will be run in async mode. | ||
| scriptInstanceCode | string | element | 0/1 | The script instance code. | ||
| scriptParams | (custom) | element | 0/1 | The script params. | ||
Properties inherited from enableBusinessDto |
||||||
| code | string | attribute | 1/1 | The code | ||
| description | string | attribute | 0/1 | The description | ||
| id | long | attribute | 0/1 | The id. | ||
| auditable | auditableDto | element | 0/1 | |||
| auditableField | auditableFieldDto | element | 0/unbounded | |||
| disabled | boolean | element | 0/1 | Is entity disabled. Value is ignored in Update action - use enable/disable API instead. | ||
| updatedCode | string | element | 0/1 | The updated code. | ||
Example
<WebhookNotification code="..." description="..." id="...">
<httpProtocol>...</httpProtocol>
<host>...</host>
<port>...</port>
<page>...</page>
<httpMethod>...</httpMethod>
<username>...</username>
<password>...</password>
<headers>...</headers>
<params>...</params>
<classNameFilter>...</classNameFilter>
<eventTypeFilter>...</eventTypeFilter>
<elFilter>...</elFilter>
<scriptInstanceCode>...</scriptInstanceCode>
<scriptParams>...</scriptParams>
<counterTemplate>...</counterTemplate>
<priority>...</priority>
<runAsync>...</runAsync>
<disabled>...</disabled>
<auditable/>
<auditableFields>
<auditableField/>
</auditableFields>
<updatedCode>...</updatedCode>
</WebhookNotification>