Panel | |
---|---|
|
Overview
Universal Controller supports the following RESTful-based web services for Webhooks operations, which are listed alphabetically on this page.
...
...
Formatting specifications for each web service, including details about parameter requirements, are provided.
Anchor | ||||
---|---|---|---|---|
|
Assign an Execution User to a Webhook
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 |
|
...
Assign an Execution User to a Webhook
...
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.
...
: Payload Properties
Property | UI Field Name | Description | Specifications | Required |
---|---|---|---|---|
| n/a | If the user executing this web service does not have the ops_admin role; Password of the Execution User. | Y | |
| n/a | Name of the Execution User. | Wildcards are supported. | Y |
Assign an Execution User to a Webhook: Example Request
XML | JSON | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Anchor | ||||
---|---|---|---|---|
|
Disable a Webhook
Description | |
---|---|
URI | http://host_name/uc/resources/webhook/enable |
HTTP Method | POST |
Description |
Disables a webhook. | |
Example URI |
Authentication | HTTP Basic |
Consumes Content-Type |
n/ |
a | |
Produces Content-Type | application/xml, application/json |
Example Request |
Example Response |
Enable/Disable Webhooks
...
Description
...
URI
http://host_name/uc/resources/webhook/ops-enable-disable-webhook
...
HTTP Method
...
POST
...
Description
...
Enables/Disables a list of webhooks.
...
Example URI
...
Disable a Webhook: Query Parameters
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|---|
| ID used within the Controller to identify this webhook. | String; URI parameter. | Y |
| |
| Name | Name used within the Controller to identify this webhook. | String; URI parameter. | Y |
|
Anchor | ||||
---|---|---|---|---|
|
Enable a Webhook
Description | |
---|---|
URI | http://host_name/uc/resources/webhook/ |
enable |
Authentication
HTTP |
Consumes Content-Type
Method | POST |
Description | Enables a webhook. |
Example URI | |
Authentication | HTTP Basic |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
Example Request |
See Enable/Disable a Webhook: XML and JSON Examples.
Example Response
http://localhost:9090/uc/resources/webhook/enable?webhookname= http://localhost:9090/uc/resources/webhook/enable?webhookid= | |
Example Response |
List Webhooks
Description
URI
http://host_name/uc/resources/webhook/list
HTTP Method
GET
Description
List webhook registrations.
Example URI
Enable a Webhook: Query Parameters
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|---|
| ID used within the Controller to identify this webhook. | String; URI parameter. | Y |
| |
| Name | Name used within the Controller to identify this webhook. | String; URI parameter. | Y |
|
Anchor | ||||
---|---|---|---|---|
|
Enable/Disable Webhooks
Description | |
---|---|
URI | http://host_name/uc/resources/webhook/ |
ops-enable-disable-webhook | |
HTTP Method | POST |
Description | Enables/Disables a list of webhooks. |
Example URI |
Authentication | HTTP Basic |
Consumes Content-Type |
application/xml, application/json | |
Produces Content-Type |
Example Responses
...
credentials
...
Credentials
...
Credentials to be used to authenticate
...
N
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 Request
See Unassign an Execution User to a Trigger: URI Parameters.
Example Response
Successfully unassigned execution user "test" to webhook "testWebhook".
application/xml, application/json | |
Example Request | 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.
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 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 of Business Services
Business Services that this record belongs to.
...
Code Block | ||
---|---|---|
| ||
<opswiseGroups>
<opswiseGroup>group1</opswiseGroup>
<opswiseGroup>group2</opswiseGroup>
</opswiseGroups> |
JSON
Code Block | ||
---|---|---|
| ||
"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 | ||
---|---|---|
| ||
<event label="Test Event A">test_event_a</event> |
JSON
Code Block | ||
---|---|---|
| ||
"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 | ||
---|---|---|
| ||
<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 | ||
---|---|---|
| ||
<urlParameters>
<urlParameter>
<name>param1</name>
<value>value1</value>
</urlParameter>
<urlParameter>
<name>param2</name>
<value>value2</value>
</urlParameter>
</urlParameters> |
...
N
Example Response | See Enable/Disable a Webhook: XML and JSON Examples. |
Enable/Disable Webhooks: Payload Properties
Property | UI Field Name | Description |
---|---|---|
| n/a | There are two attributes for this property:
For example: <webhook enable="true" name="test-1"></webhook> |
Anchor | ||||
---|---|---|---|---|
|
Enable/Disable a Webhook: XML and JSON Examples
XML | JSON | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Example Request |
|
| ||||||||||
Example Response |
|
|
Anchor | ||||
---|---|---|---|---|
|
List Webhooks
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 |
---|---|---|---|---|
| Name | Name used within the Controller to identify this webhook. | String; URI parameter. | N |
| Description | User-defined; description of this record. | String; URI parameter. | N |
| Action | Type of Action | String; URI parameter. | N |
| Member of Business Services | Business Services that this record belongs to. | String; URI parameter. | N |
| Event | event name | String; URI parameter. | N |
| Task | task name | String; URI parameter. | N |
List Webhooks: Example Response
XML | JSON | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Anchor | ||||
---|---|---|---|---|
|
Modify Webhooks
Description | |
---|---|
URI | http://host_name/uc/resources/webhook |
HTTP Method | PUT |
Description | Modify a webhook. |
Example URI | |
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 |
|
Modify Webhooks: Example Request
XML | JSON | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Anchor | ||||
---|---|---|---|---|
|
Read a Webhook
Description | |
---|---|
URI | http://host_name/uc/resources/webhook |
HTTP Method | GET |
Description | Read webhook registration. |
Example URI | |
Authentication | HTTP Basic |
Produces Content-Type | application/xml, application/json |
Consumes Content-Type | n/a |
Example Responses | See Read a Webhook: Example Response, below. |
Anchor | ||||
---|---|---|---|---|
|
Read a Webhook: Query Parameters
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|---|
| ID used within the Controller to identify this webhook. | String; URI parameter. | Y |
| |
| Name | Name used within the Controller to identify this webhook. | String; URI parameter. | Y |
|
Read a Webhook: Example Response
XML | JSON | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Anchor | ||||
---|---|---|---|---|
|
Register a Webhook
Description | |
---|---|
URI | http://host_name/uc/resources/webhook |
HTTP Method | POST |
Description | Register a webhook. |
Example URI | |
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, below. |
Example Responses |
|
Anchor | ||||
---|---|---|---|---|
|
Register a Webhook: Payload Properties
Property | UI Field Name | Description | Specifications | Required | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Webhook Name | Name of the Webhook. | Y | |||||||||||||
| Description | User-defined; description of this record. | N | |||||||||||||
| Member of Business Services | Business Services that this record belongs to.
JSON
| N | |||||||||||||
| n/a | Specification for whether or not the Create a Webhook web service will persist the sysId property.
Note In XML web services, | Valid values: true/false (default is true). | N | ||||||||||||
| Action | Type of Action to perform | Valid Values:
Default is URL (1). | Y | ||||||||||||
| Event | Universal Event Template name. XML
JSON
| The | Y | ||||||||||||
| Event Criteria | Universal Event criteria to to execute the webhook. | N | |||||||||||||
| URL | full URL of the action to be executed. (Including parameters) | Y (if action | |||||||||||||
| Task | Task of the action to be executed. (Including parameters) | Y (if action | |||||||||||||
| HTTP Authentication | HTTP authentication scheme to use. | Valid values:
Default is None (0). | N | ||||||||||||
| HTTP Headers | HTTP headers. | Format:
| N | ||||||||||||
| URL Query Parameters | Any query parameters to be encoded as a query string and appended to the URL. | Format:
| N | ||||||||||||
| Credentials | Credentials to be used to authenticate | N |
Register a Webhook: Example Request
XML Request | JSON Request | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Anchor | ||||
---|---|---|---|---|
|
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 |
|
Unassign an Execution User from a Webhook: Query Parameters
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|---|
| ID used within the Controller to identify this webhook. | String; URI parameter. | Y |
| |
| Name | Name used within the Controller to identify this webhook. | String; URI parameter. | Y |
|
Anchor | ||||
---|---|---|---|---|
|
Unregister a Webhook
Description | |
---|---|
URI | http://host_name/uc/resources/webhook |
HTTP Method | DELETE |
Description | Unregister a webhook. |
Example URI | |
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.Example Responses | Webhook deleted successfully. |
Unregister a Webhook: Query Parameters
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|---|
| ID used within the Controller to identify this webhook. | String; URI parameter. | Y |
| |
| Name | Name used within the Controller to identify this webhook. | String; URI parameter. | Y |
|