Page Comparison

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

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

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

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.