Page Comparison

Panel

Table of Contents

...

	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.

...

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

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

filter

Event Attribute Criteria

Universal Event criteria to execute the Webhook.

N

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

<eventBusinessServices>
    <businessService>A</businessService>
    <businessService>B</businessService>
</eventBusinessServices>

JSON

Code Block

language	text

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

...

Versions Compared

Old Version 4

New Version 5

Key