	Description
URI	http://host_name/uc/resources/webhook/assignexecutionuser
HTTP Method	POST
Description	Assigns an Execution User to the specified webhook.
Example URI	http://localhost:8080/uc/resources/webhook/assignexecutionuser?webhookid= http://localhost:8080/uc/resources/webhook/assignExecutionUser?webhookname=
Authentication	HTTP Basic
Consumes Content-Type	application/xml, application/json
Produces Content-Type	N/A
Example Request	See Assign an Execution User to a Webhook: Example Request Properties.
Example Response	Status 200 /OK Successfully assigned execution user "test" to webhook "testWebhook". Status 404 /Not Found Assign Execution User failed. You must provide an execution user.

	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

http://host_name/uc/resources/webhook/enable

http://localhost:9090

Property	UI Field Name	Description	URI
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	Specifications	Required	Mutually Exclusive With
`webhookid`		ID used within the Controller to identify this webhook.	String; URI parameter.	Y (unless `webhookname` is specified)	`webhookname`
`webhookname`		Name used within the Controller to identify this webhook.	String; URI parameter.	Y (unless `webhookid` is specified)	`webhookid`

Enable a Webhook

	Description
URI	http://host_name/uc/resources/webhook/enable?webhookname=
HTTP Method	POST
Description	Enables a webhook.
Example URI	http://localhost:90908080/uc/resources/webhook/enable?webhookid=
Example Response	See Enable/Disable a Webhook: XML and JSON Examples.

Enable/Disable Webhooks

Description	URI	http://host_name
Authentication	HTTP Basic
Consumes Content-Type	N/A
Produces Content-Type	application/xml, application/json
Example Request	Example URI	http://localhost:9090/uc/resources/webhook/ops-enable-disable-webhook
HTTP Method	POST
Description	Enables/Disables a list of webhooks.
enable?webhookname= http://localhost:80809090/uc/resources/webhook/ops-enable-disable-webhook
Authentication	HTTP Basic
Consumes Content-Type	application/xml, application/json
Produces Content-Type	application/xml, application/json
Example Requestenable?webhookid=
Example Response	See Enable/Disable a Webhook: XML and JSON Examples.Example ResponseSee

Enable

...

a Webhook:

...

List Webhooks

...

Description

...

URI

...

http://host_name/uc/resources/webhook/list

...

HTTP Method

...

GET

...

Description

...

List webhook registrations.

...

Query Parameters

Property	UI Field Name	Description	Specifications	Required	Mutually Exclusive With
`webhookid`		ID used within the Controller to identify this webhook.	String; URI parameter.	Y (unless `webhookname` is specified)	`webhookname`
`webhookname`	Name	Name used within the Controller to identify this webhook.	String; URI parameter.	Y (unless `webhookid` is specified)	`webhookid`

Enable/Disable Webhooks

	Description
URI	http://localhost:8080host_name/uc/resources/webhook/list?webhookname=http://localhost:8080/uc/resources/webhook/list?action=ops-enable-disable-webhook
HTTP Method	POST
Description	Enables/Disables a list of webhooks.
Example URI	http://localhost:8080/uc/resources/webhook/list?description=ops-enable-disable-webhook
Authentication	HTTP Basic
Produces Consumes Content-TypeConsumes	application/xml, application/json
Produces Content-Type	application/xml, application/json
Example ResponsesList WebhookRequest	See Enable/Disable a Webhook: XML and JSON Examples.

Modify Webhooks

...

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

...

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.

Read a Webhook

...

Description

...

URI

...

http://host_name/uc/resources/webhook

...

HTTP Method

...

GET

...

Description

...

Read webhook registration.

...

Example URI

...

http://localhost:8080/uc/resources/webhook?webhookid=

http://localhost:8080/uc/resources/webhook?webhookname=

...

Authentication

...

HTTP Basic

...

Produces Content-Type

...

Consumes Content-Type

...

Example Responses

...

Read Webhook: XML and JSON Examples.

...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

...

webhookid

...

ID used within the Controller to identify this webhook.

...

String; URI parameter.

...

Y
(unless webhookname
is specified)

...

webhookname

...

webhookname

...

Name

...

Name used within the Controller to identify this webhook.

...

String; URI parameter.

...

Y
(unless webhookid
is specified)

...

webhookid

Register a Webhook

Example Response

See Enable/Disable a Webhook: XML and JSON Examples.

Enable/Disable Webhooks: Payload Properties

Property UI Field Name Description

webhook

n/a

There are two attributes for this property:

enable: Indication of whether to enable or disable the webhook. Only enabled webhooks are processed by the Controller. Boolean; Valid values: true/false.
name: Name used within the Controller to identify this webhook. Maximum of 100 alphanumerics.

For example: <webhook enable="true" name="test-1"></webhook>

Enable/Disable a Webhook: XML and JSON Examples

XML

JSON

Example Request

Code Block

language	text

<enable-disable-webhook>
    <webhook enable="true" name="test-1"></webhook>
    <webhook enable="false" name="test-3"></webhook>
</enable-disable-webhook>

Code Block

language	text

 [{
     "enable": true,
     "name": "test-1"
  },
  {
     "enable": false,
     "name": "test-3"
  }]

Example Response

Code Block

language	text

<command-response>
    <type>Enable/Disable Webhooks</type>
    <success>true</success>
    <info>Successfully disabled Webhook "test-3"., Successfully enabled Webhook "test-1".</info>
    <errors></errors>
</command-response>

Code Block

language	text

{
    "type": "Enable/Disable Webhooks",
    "success": true,
    "info": "Successfully disabled Webhook \"test-3\"., Successfully enabled Webhook \"test-1\".",
    "errors": ""
}

List Webhooks

	Description
URI	http://host_name/uc/resources/webhook/list
HTTP Method	POSTGET
Description	Register a List webhook registrations.
Example URI	http://localhost:8080/uc/resources/webhook	Authentication	/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	Application/XML Application/JSON
Example Request	See Register a Webhook: Example Request
Example Responses	Status 200 Successfully created the webhook with id {uuid}. Status 400 Error message. Status 403 Operation prohibited due to security constraints. Status 404 A webhook with name “{name}” does not exist. A webhook 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 Example Responses	List Webhook: XML and JSON Examples.

List Webhooks: Query Parameters

Property

UI Field Name

Description

Specifications

Required

webhookname

Name

Name used within the Controller to identify this webhook.

String; URI parameter.

N

description

Description

User-defined; description of this record.

String; URI parameter.

N

action

Action

Type of Action

String; URI parameter.

N

businessServices

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

String; URI parameter.

N

event

Event

event name

String; URI parameter.

N

task

Task

task name

String; URI parameter.

N

List Webhooks: Example Response

XML

JSON

Expand

title	XML

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<webhooks>
    <webhook exportReleaseLevel="7.4.0.0" exportTable="ops_webhook">
        <action>Url</action>
        <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>
        <task />
        <url>test</url>
        <urlParameters>
            <urlParameter>
                <name>A</name>
                <value>abc</value>
            </urlParameter>
        </urlParameters>
    </webhook>
    <webhook exportReleaseLevel="7.4.0.0" exportTable="ops_webhook">
        <action>Url</action>
        <credentials>web-serv-1</credentials>
        <description />
        <disabledBy>ops.admin</disabledBy>
        <disabledTime>2023-03-15 14:00:59 -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>X</name>
                <value>123</value>
            </httpHeader>
        </httpHeaders>
        <name>test-2</name>
        <opswiseGroups/>
        <status>Disabled</status>
        <statusDescription></statusDescription>
        <sysId>bb0bf1ae08cb4ac3a8df69bc5548281c</sysId>
        <task />
        <url>test</url>
        <urlParameters>
            <urlParameter>
                <name>A</name>
                <value>abc</value>
            </urlParameter>
        </urlParameters>
    </webhook>
</webhooks>

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"
        },
        "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"
        ],
        "status": "Disabled",
        "statusDescription": "",
        "sysId": "401b83365dcd48cf8a8518849dfb28c4",
        "task": null,
        "url": "test",
        "urlParameters": [
            {
                "name": "A",
                "value": "abc"
            }
        ]
    },
    {
        "action": "Url",
        "credentials": "web-serv-1",
        "description": null,
        "disabledBy": "ops.admin",
        "disabledTime": "2023-03-15 14:00:59 -0400",
        "enabledBy": "",
        "enabledTime": "",
        "event": {
            "label": "UAC - Agent Changed",
            "value": "uac_agent_changed"
        },
        "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": "X",
                "value": "123"
            }
        ],
        "name": "test-2",
        "opswiseGroups": [],
        "status": "Disabled",
        "statusDescription": "",
        "sysId": "bb0bf1ae08cb4ac3a8df69bc5548281c",
        "task": null,
        "url": "test",
        "urlParameters": [
            {
                "name": "A",
                "value": "abc"
            }
        ]
    }
]

Modify Webhooks

	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.

Modify Webhooks: Example Request

XML

JSON

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">
    <action>Launch Task</action>
    <description>test 1</description>
    <disabledBy />
    <disabledTime></disabledTime>
    <enabledBy />
    <enabledTime></enabledTime>
    <event label="UAC - Property Changed">uac_property_changed</event>
    <executionUser />
    <filter>
        <criterion>
            <name>name</name>
            <operator>CONTAINS</operator>
            <value>Suspended</value>
        </criterion>
        <logicalOperator>And</logicalOperator>
    </filter>
    <name>test-1</name>
    <opswiseGroups>
        <opswiseGroup>A</opswiseGroup>
        <opswiseGroup>B</opswiseGroup>
    </opswiseGroups>
    <status />
    <sysId>63eacfe0b0534768ab7b5bef49212276</sysId>
    <task>Sleep 0</task>
    <url />
</webhook>

Expand

title	JSON

Code Block

language	text

{
    "action": "Launch Task",
    "description": "test 1",
    "disabledBy": null,
    "disabledTime": "",
    "enabledBy": null,
    "enabledTime": "",
    "event": {
        "label": "UAC - Property Changed",
        "value": "uac_property_changed"
    },
    "executionUser": null,
    "exportReleaseLevel": "7.4.0.0",
    "exportTable": "ops_webhook",
    "filter": {
        "criteria": [
            {
                "type": "criterion",
                "name": "name",
                "operator": "CONTAINS",
                "value": "Suspended"
            }
        ],
        "logicalOperator": "And"
    },
    "name": "test-1",
    "opswiseGroups": [
        "A",
        "B"
    ],
    "retainSysIds": true,
    "status": null,
    "sysId": "63eacfe0b0534768ab7b5bef49212276",
    "task": "Sleep 0",
    "url": null
}

Read a Webhook

	Description
URI	http://host_name/uc/resources/webhook
HTTP Method	GET
Description	Read webhook registration.
Example URI	http://localhost:8080/uc/resources/webhook?webhookid= http://localhost:8080/uc/resources/webhook?webhookname=
Authentication	HTTP Basic
Produces Content-Type
Consumes Content-Type
Example Responses	Read Webhook: XML and JSON Examples.

Anchor
query parameters
query parameters
Read a Webhook: Query Parameters

Property	UI Field Name	Description	Specifications	Required	Mutually Exclusive With
`webhookid`		ID used within the Controller to identify this webhook.	String; URI parameter.	Y (unless `webhookname` is specified)	`webhookname`
`webhookname`	Name	Name used within the Controller to identify this webhook.	String; URI parameter.	Y (unless `webhookid` is specified)	`webhookid`

Read a Webhook: Example Response

XML

JSON

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">
    <action>Url</action>
    <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>
    <task />
    <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"
    },
    "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",
    "task": null,
    "url": "test",
    "urlParameters": [
        {
            "name": "A",
            "value": "abc"
        }
    ]
}

Register a Webhook

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

Anchor

	payload properties
	payload properties

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)

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:

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

Credentials

Credentials to be used to authenticate

N

...

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">
    <action>Url</action>
    <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>
    <task />
    <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"
    },
    "executionUser": null,
    "exportReleaseLevel": "7.4.0.0",
    "exportTable": "ops_webhook",
    "filter": {
        "criteria": [
            {
                "type": "criterion",
                "name": "name",
          "type      "operator": "CONTAINS",
                "value": "criteriontest1",
            }
   "name": "name",      ],
          "operatorlogicalOperator": "CONTAINSAnd",
    },
    "httpAuth": "Basic",
     "valuehttpHeaders": "test1"[
        {
    }         ]"name": "B",
            "logicalOperatorvalue": "And123"
        }
    ],
    "httpAuthname": "Basictest-1",
    "httpHeadersopswiseGroups": [
        {   "A"
    ],
    "nameretainSysIds": "B"true,
    "status": "Disabled",
      "valuestatusDescription": "123",
    "sysId": "401b83365dcd48cf8a8518849dfb28c4",
  }     ]"task": null,
    "nameurl": "test-1",
    "opswiseGroupsurlParameters": [
        "A"{
       ],     "retainSysIdsname": true"A",
    "status": "Disabled",        "statusDescriptionvalue": "abc",
     "sysId": "401b83365dcd48cf8a8518849dfb28c4",  }
  "task": null,     "url": "test",
    "urlParameters": [
        {
            "name": "A",
            "value": "abc"
        }
    ]
}

Unassign an Execution User from a Webhook

http://host_name/uc/resources/webhook/unassignexecutionuser

Description

URI

HTTP Method

POST

Description

Unassigns an Execution User to the specified webhook.

Example URI

http://localhost:8080/uc/resources/webhook/unassignexecutionuser?webhookid=

http://localhost:8080/uc/resources/webhook/unassignExecutionUser?webhookname=

Authentication

HTTP Basic

Consumes Content-Type

application/xml, application/json

Produces Content-Type

N/A

Example Request

See Unassign an Execution User to a Trigger: URI Parameters.

Example Response

Status 200 /OK
Successfully unassigned execution user "test" to webhook "testWebhook".

]
}

Unassign an Execution User from a Webhook

	Description
URI	http://host_name/uc/resources/webhook/unassignexecutionuser
HTTP Method	POST
Description	Unassigns an Execution User to the specified webhook.
Example URI	http://localhost:8080/uc/resources/webhook/unassignexecutionuser?webhookid= http://localhost:8080/uc/resources/webhook/unassignExecutionUser?webhookname=
Authentication	HTTP Basic
Consumes Content-Type	application/xml, application/json
Produces Content-Type	N/A
Example Response	Status 200 /OK Successfully unassigned execution user "test" to webhook "testWebhook".

Unassign an Execution User from a Webhook: Query Parameters

Property	UI Field Name	Description	Specifications	Required	Mutually Exclusive With
`webhookid`		ID used within the Controller to identify this webhook.	String; URI parameter.	Y (unless `webhookname` is specified)	`webhookname`
`webhookname`	Name	Name used within the Controller to identify this webhook.	String; URI parameter.	Y (unless `webhookid` is specified)	`webhookid`

Unregister a Webhook

	Description
URI	http://host_name/uc/resources/webhook
HTTP Method	DELETE
Description	Unregister a webhook.
Example URI	http://localhost:8080/uc/resources/webhook?webhookname= http://localhost:8080/uc/resources/webhook?webhookid=
Authentication	HTTP Basic
Produces Content-Type
Consumes Content-Type
Example Responses	Status 200 Successfully created the resourcename with id {uuid}. Status 400 Error message. Status 403 Operation prohibited due to security constraints. Status 404 A webhook with name “{name}” does not exist. A webhook with id "{uuid}" does not exist. Status 500 Unexpected request failure. See log(s) for more details.

...

Versions Compared

Old Version 5

New Version 6

Key

Disable a Webhook

: Query Parameters

Enable a Webhook

Enable/Disable Webhooks

Enable

a Webhook:

List Webhooks

Query Parameters

Enable/Disable Webhooks

Modify Webhooks

Read a Webhook

Register a Webhook

Enable/Disable Webhooks: Payload Properties

Enable/Disable a Webhook: XML and JSON Examples

List Webhooks

Register a Webhook: Payload Properties

List Webhooks: Query Parameters

List Webhooks: Example Response

Modify Webhooks

Modify Webhooks: Example Request

Read a Webhook

Anchor
query parameters
query parameters
Read a Webhook: Query Parameters

Read a Webhook: Example Response

Register a Webhook

Register a Webhook: Payload Properties

Unassign an Execution User from a Webhook

Unassign an Execution User from a Webhook

Unassign an Execution User from a Webhook: Query Parameters

Unregister a Webhook

Page Comparison

Versions Compared

Old Version 5

New Version 6

Key

Disable a Webhook

: Query Parameters

Enable a Webhook

Enable/Disable Webhooks

Enable

a Webhook:

List Webhooks

Query Parameters

Enable/Disable Webhooks

Modify Webhooks

Read a Webhook

Register a Webhook

Enable/Disable Webhooks: Payload Properties

Enable/Disable a Webhook: XML and JSON Examples

List Webhooks

Register a Webhook: Payload Properties

List Webhooks: Query Parameters

List Webhooks: Example Response

Modify Webhooks

Modify Webhooks: Example Request

Read a Webhook

Anchorquery parameters query parameters Read a Webhook: Query Parameters

Read a Webhook: Example Response

Register a Webhook

Register a Webhook: Payload Properties

Unassign an Execution User from a Webhook

Unassign an Execution User from a Webhook

Unassign an Execution User from a Webhook: Query Parameters

Unregister a Webhook

Anchor
query parameters
query parameters
Read a Webhook: Query Parameters