Page Comparison

Panel

Table of Contents

...

	Description
URI	http://host_name/uc/resources/webhook/enable
HTTP Method	POST
Description	Disables a webhook.
Example URI	http://localhost:8080/uc/resources/webhook/disable
Authentication	HTTP Basic
Consumes Content-Type	n/a
Produces Content-Type	application/xml, application/json
Example Request	http://localhost:9090/uc/resources/webhook/disable?webhookname= http://localhost:9090/uc/resources/webhook/disable?webhookid=
Example Response	See Enable/Disable a Webhook: XML and JSON Examples.

Disable a Webhook: Query Parameters

...

	Description
URI	http://host_name/uc/resources/webhook/enable
HTTP Method	POST
Description	Enables a webhook.
Example URI	http://localhost:8080/uc/resources/webhook/enable
Authentication	HTTP Basic
Consumes Content-Type	n/a
Produces Content-Type	application/xml, application/json
Example Request	http://localhost:9090/uc/resources/webhook/enable?webhookname= http://localhost:9090/uc/resources/webhook/enable?webhookid=
Example Response	See Enable/Disable a Webhook: XML and JSON Examples.

Enable a Webhook: Query Parameters

...

	Description
URI	http://host_name/uc/resources/webhook/list
HTTP Method	GET
Description	List webhook registrations.
Example URI	http://localhost:8080/uc/resources/webhook/list?webhookname= http://localhost:8080/uc/resources/webhook/list?action= http://localhost:8080/uc/resources/webhook/list?description=
Authentication	HTTP Basic
Produces Content-Type	application/xml, application/json
Consumes Content-Type	n/a
Example Responses	List Webhook: XML and JSON Examples.

...

	Description
URI	http://host_name/uc/resources/webhook
HTTP Method	PUT
Description	Modify a webhook.
Example URI	http://localhost:8080/uc/resources/webhook
Authentication	HTTP Basic
Payload Properties	See Register a Webhook: Payload Properties.
Produces Content-Type	application/xml, application/json
Consumes Content-Type	application/xml, application/json
Example Responses	Status 200 Successfully updated the resourcename with id {uuid}. Status 400 Error message. Status 403 Operation prohibited due to security constraints. Status 404 A resourcename with name “{name}” does not exist. A resourcename with id "{uuid}" does not exist. Status 500 Unexpected request failure. See log(s) for more details.

...

Register a Webhook: Payload Properties

Property

UI Field Name

Description

Specifications

Required

name

Webhook Name

Name of the Webhook.

Y

description

Description

User-defined; description of this record.

N

opswiseGroups

Member of Business Services

Business Services that this record belongs to.

XML

Code Block

language	text

<opswiseGroups>
      <opswiseGroup>group1</opswiseGroup>
      <opswiseGroup>group2</opswiseGroup>
</opswiseGroups>

JSON

Code Block

language	text

"opswiseGroups": ["group1","group2"]

N

retainSysIds

n/a

Specification for whether or not the Create a Webhook web service will persist the sysId property.

If retainSysIds="true" and sysId is included in the request/response, sysId will be persisted to the database.
If retainSysIds="false" and sysId is included in the request/response, sysId will be ignored; it will be autogenerated by the Controller.

Note

In XML web services, retainSysIds is specified as an attribute in the <webhook> element.

Valid values: true/false (default is true).

N

action

Action

Type of Action to perform

Valid Values:

As String = URL, As Value = 1
As String = Launch Task, As Value = 2

Default is URL (1).

Y

event

Event

Universal Event Template name.

XML

Code Block

language	text

<event label="Test Event A">test_event_a</event>

JSON

Code Block

language	text

"event": {

    "label": "Test Event A",

    "value": "test_event_a"

}

Note
Only system level event templates will be allowed.

The label is included when reading a Webhook; however, it is ignored when creating/updating a Webhook.

Y

filter

Event Criteria

Universal Event criteria to to execute the webhook.

N

url

URL

full URL of the action to be executed. (Including parameters)

Y

(if action
= Url)

taskname

Task

Task of the action to be executed. (Including parameters)

Y

(if action
= Launch Taskl)

httpAuth

HTTP Authentication

HTTP authentication scheme to use.

Valid values:

As String = None, As Value = 0
As String = Basic, As Value = 1

Default is None (0).

N

credentials

Credentials

Credentials to be used to authenticate.

N

httpHeaders

HTTP Headers

HTTP headers.

Format:

Code Block

language	text

<httpHeaders>
	<httpHeader>
		<name>header1</name>
		<value>val1</value>
	</httpHeader>
	<httpHeader>
		<name>header2</name>
		<value>val2</value>
	</httpHeader>
</httpHeaders>

N

urlParameters

URL Query Parameters

Any query parameters to be encoded as a query string and appended to the URL.

Format:

Code Block

language	text

<urlParameters>
      <urlParameter>
            <name>param1</name>
            <value>value1</value>
      </urlParameter>
      <urlParameter>
            <name>param2</name>
            <value>value2</value>
      </urlParameter>
</urlParameters>

N

credentials

filter

Credentials

Credentials to be used to authenticateXML RequestJSON Request Expand

title	XML

Event Attribute Criteria

Universal Event criteria to execute the Webhook.

N

Register a Webhook: Example Request

eventBusinessServiceCriteria

Event Business Service Criteria

Specifies the type of business service filtering to apply when monitoring on Universal Events.

Valid values (case-insensitive):

As String = Member of Any Business Service or Unassigned, As Value = 1
As String = Member of Specific Business Services or Unassigned, As Value = 2
As String = Member of Specific Business Services, As Value = 3
As String = Unassigned, As Value = 4

Default is Member of Any Business Service or Unassigned (1).

N

eventBusinessServices

Event Member of Business Services

Specifies one or more business services to filter on when Event Business Service Criteria is one of the following.

Member of Specific Business Services or Unassigned
Member of Specific Business Services

Format:

XML

Code Block

language	text

JSON

Code Block

language	text

"eventBusinessServices": ["A, "B"]

Register a Webhook: Example Request

XML Request

JSON Request

Expand

title	XML

Code Block

language	text

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<webhook exportReleaseLevel="7.4.0.0" exportTable="ops_webhook" retainSysIds="true">" exportTable="ops_webhook" retainSysIds="true">
    <action>Url</action>
    <eventBusinessServiceCriteria>Member of Specific Business Services or Unassigned</eventBusinessServiceCriteria>
    <eventBusinessServices>
        <businessService>X</businessService>
        <businessService>Y</businessService>
        <businessService>Z</businessService>
    <action>Url<</action>eventBusinessServices>
    <credentials>web-serv-1</credentials>
    <description />
    <disabledBy>ops.admin</disabledBy>
    <disabledTime>2023-03-15 15:34:24 -0400</disabledTime>
    <enabledBy></enabledBy>
    <enabledTime></enabledTime>
    <event label="UAC - Agent Changed">uac_agent_changed</event>
    <executionUser />
    <filter>
        <criterion>
            <name>name</name>
            <operator>CONTAINS</operator>
            <value>test1</value>
        </criterion>
        <logicalOperator>And</logicalOperator>
    </filter>
    <httpAuth>Basic</httpAuth>
    <httpHeaders>
        <httpHeader>
            <name>B</name>
            <value>123</value>
        </httpHeader>
    </httpHeaders>
    <name>test-1</name>
    <opswiseGroups>
        <opswiseGroup>A</opswiseGroup>
    </opswiseGroups>
    <status>Disabled</status>
    <statusDescription></statusDescription>
    <sysId>401b83365dcd48cf8a8518849dfb28c4</sysId>
    <taskname/>
    <url>test</url>
    <urlParameters>
        <urlParameter>
            <name>A</name>
            <value>abc</value>
        </urlParameter>
    </urlParameters>
</webhook>

Expand

title	JSON

Code Block

language	text

{
    "action": "Url",
    "credentials": "web-serv-1",
    "description": null,
    "disabledBy": "ops.admin",
    "disabledTime": "2023-03-15 15:34:24 -0400",
    "enabledBy": "",
    "enabledTime": "",
    "event": {
        "label": "UAC - Agent Changed",
        "value": "uac_agent_changed"
    },
"eventBusinessServiceCriteria": "Member of Specific Business Services or Unassigned",
    "eventBusinessServices": [
        "X",
        "Y",
        "Z"
    ],
    "executionUser": null,
    "exportReleaseLevel": "7.4.0.0",
    "exportTable": "ops_webhook",
    "filter": {
        "criteria": [
            {
                "type": "criterion",
                "name": "name",
                "operator": "CONTAINS",
                "value": "test1"
            }
        ],
        "logicalOperator": "And"
    },
    "httpAuth": "Basic",
    "httpHeaders": [
        {
            "name": "B",
            "value": "123"
        }
    ],
    "name": "test-1",
    "opswiseGroups": [
        "A"
    ],
    "retainSysIds": true,
    "status": "Disabled",
    "statusDescription": "",
    "sysId": "401b83365dcd48cf8a8518849dfb28c4",
    "taskname": null,
    "url": "test",
    "urlParameters": [
        {
            "name": "A",
            "value": "abc"
        }
    ]
}

...

Versions Compared

Old Version 2

New Version 3

Key

Disable a Webhook: Query Parameters

Enable a Webhook: Query Parameters

Register a Webhook: Payload Properties

Register a Webhook: Example Request

Register a Webhook: Example Request