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 |
---|---|
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: 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 |
---|---|
|
|
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 |
http://localhost:9090/uc/resources/webhook/disable?webhookname= http://localhost:9090/uc/resources/webhook/disable?webhookid= |
Example Response |
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 |
|
Enable a Webhook
|
Description |
---|---|
URI |
http://host_name/uc/resources/webhook/enable |
HTTP 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 |
http://localhost:9090/uc/resources/webhook/enable?webhookname= http://localhost:9090/uc/resources/webhook/enable?webhookid= |
Example Response |
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 |
|
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 |
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 |
---|---|---|
|
n/a |
There are two attributes for this property:
For example: <webhook enable="true" name="test-1"></webhook> |
Enable/Disable a Webhook: XML and JSON Examples
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 |
---|---|
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 |
---|---|
|
|
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 |
---|---|
|
|
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 |
n/a |
Consumes Content-Type |
application/xml, application/json |
Example Responses |
Read Webhook: XML and JSON Examples, below. |
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 |
---|---|
|
|
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 |
|
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.
<opswiseGroups> <opswiseGroup>group1</opswiseGroup> <opswiseGroup>group2</opswiseGroup> </opswiseGroups>
JSON "opswiseGroups": ["group1","group2"] |
|
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 <event label="Test Event A">test_event_a</event> JSON "event": { "label": "Test Event A", "value": "test_event_a" } Only system level event templates will be allowed. |
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: <httpHeaders> <httpHeader> <name>header1</name> <value>val1</value> </httpHeader> <httpHeader> <name>header2</name> <value>val2</value> </httpHeader> </httpHeaders> |
N |
|
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 to be used to authenticate |
|
N |
Register a Webhook: Example Request
XML Request | JSON Request |
---|---|
|
|
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 |
|
Unregister a Webhook
|
Description |
---|---|
URI |
http://host_name/uc/resources/webhook |
HTTP Method |
DELETE |
Description |
Unregister a webhook. |
Example URI |
|
Authentication |
HTTP Basic |
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 |
|