1 Overview
2 Assign an Execution User to a Webhook
- 2.1 Assign an Execution User to a Webhook: Payload Properties
- 2.2 Assign an Execution User to a Webhook: Example Request
3 Disable a Webhook
- 3.1 Disable a Webhook: Query Parameters
4 Enable a Webhook
- 4.1 Enable a Webhook: Query Parameters
5 Enable/Disable Webhooks
- 5.1 Enable/Disable Webhooks: Payload Properties
- 5.2 Enable/Disable a Webhook: XML and JSON Examples
6 List Webhooks
- 6.1 List Webhooks: Query Parameters
- 6.2 List Webhooks: Example Response
7 Modify Webhooks
- 7.1 Modify Webhooks: Example Request
8 Read a Webhook
- 8.1 Read a Webhook: Query Parameters
- 8.2 Read a Webhook: Example Response
9 Register a Webhook
- 9.1 Register a Webhook: Payload Properties
- 9.2 Register a Webhook: Example Request
10 Unassign an Execution User from a Webhook
- 10.1 Unassign an Execution User from a Webhook: Query Parameters
11 Unregister a Webhook
- 11.1 Unregister a Webhook: Query Parameters

Overview

Universal Controller supports the following RESTful-based web services for Webhooks operations, which are listed alphabetically on this page.

Assign an Execution User to a Webhook
Disable a Webhook
Enable a Webhook
Enable/Disable Webhooks
List Webhooks
Modify Webhooks
Read a Webhook
Register a Webhook
Unassign an Execution User from a Webhook
Unregister a Webhook

Formatting specifications for each web service, including details about parameter requirements, are provided.

Assign an Execution User to a Webhook

	Description

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

Assign an Execution User to a Webhook: Payload Properties

Property	UI Field Name	Description	Specifications	Required

Property	UI Field Name	Description	Specifications	Required
`password`	n/a	If the user executing this web service does not have the ops_admin role; Password of the Execution User.		Y
`username`	n/a	Name of the Execution User.	Wildcards are supported.	Y

Assign an Execution User to a Webhook: Example Request

XML	JSON

XML	JSON
`<executionUser> <username>test</username> <password>pass1</password> </executionUser>`	`{ "username": "test", "password": "pass1" }`

Disable a Webhook

	Description

	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

Property	UI Field Name	Description	Specifications	Required	Mutually Exclusive With

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 a Webhook

	Description

	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

Property	UI Field Name	Description	Specifications	Required	Mutually Exclusive With

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

	Description
URI	http://host_name/uc/resources/webhook/ops-enable-disable-webhook
HTTP Method	POST
Description	Enables/Disables a list of webhooks.
Example URI	http://localhost:8080/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 Request	See Enable/Disable a Webhook: XML and JSON Examples.
Example Response	See Enable/Disable a Webhook: XML and JSON Examples.

Enable/Disable Webhooks: Payload Properties

Property	UI Field Name	Description

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

	XML	JSON
Example Request	`<enable-disable-webhook> <webhook enable="true" name="test-1"></webhook> <webhook enable="false" name="test-3"></webhook> </enable-disable-webhook>`	`[{ "enable": true, "name": "test-1" }, { "enable": false, "name": "test-3" }]`
Example Response	`<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>`	`{ "type": "Enable/Disable Webhooks", "success": true, "info": "Successfully disabled Webhook \"test-3\"., Successfully enabled Webhook \"test-1\".", "errors": "" }`

List Webhooks

	Description

	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.

List Webhooks: Query Parameters

Property	UI Field Name	Description	Specifications	Required

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.	String; URI parameter.	N
`event`	Event	Event name.	String; URI parameter.	N
`taskname`	Task	Task name.	String; URI parameter.	N

List Webhooks: Example Response

XML	JSON

XML

JSON

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<webhooks>
    <webhook exportReleaseLevel="7.5.0.0" exportTable="ops_webhook">
        <action>Url</action>
        <eventBusinessServiceCriteria>Member of Specific Business Services or Unassigned</eventBusinessServiceCriteria>
        <eventBusinessServices>
           <businessService>X</businessService>
           <businessService>Y</businessService>
           <businessService>Z</businessService>
        </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>
    <webhook exportReleaseLevel="7.5.0.0" exportTable="ops_webhook">
        <action>Url</action>
        <eventBusinessServiceCriteria>Member of Specific Business Services or Unassigned</eventBusinessServiceCriteria>
        <eventBusinessServices>
           <businessService>X</businessService>
           <businessService>Y</businessService>
           <businessService>Z</businessService>
        </eventBusinessServices>
        <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>

[
    {
        "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.5.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",
        "taskname": 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"
        },
    "eventBusinessServiceCriteria": "Member of Specific Business Services or Unassigned",
    "eventBusinessServices": [
        "X",
        "Y",
        "Z"
    ],
        "executionUser": null,
        "exportReleaseLevel": "7.5.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",
        "taskname": null,
        "url": "test",
        "urlParameters": [
            {
                "name": "A",
                "value": "abc"
            }
        ]
    }
]

Modify Webhooks

	Description

	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

XML	JSON

Webhooks Web Services