Panel

Table of Contents

Overview

...

	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	Nn/Aa
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.

...

	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-TypeN	n/Aa
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.

...

	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	Nn/Aa
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.

...

	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.

...

	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/JSONapplication/xml, application/json
Consumes Content-Type	Application/XML Application/JSONapplication/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.

...

	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	n/a
Consumes Content-Type	application/xml, application/json
Example Responses	Read Webhook: XML and JSON Examples, below.

...

	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/JSONapplication/xml, application/json
Consumes Content-Type	Application/XML Application/JSONapplication/xml, application/json
Example Request	See Register a Webhook: Example Request, below.
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.

...

	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	Nn/Aa
Example Response	Status 200 /OK Successfully unassigned execution user "test" to webhook "testWebhook".

...

	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	Webhook deleted successfully.

Unregister a Webhook: Query Parameters

...