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

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

JSON

"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

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)

task

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

httpHeaders

HTTP Headers

HTTP headers.

Format:

<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:
 

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

N

credentials

Credentials

Credentials to be used to authenticate

N