Update Webhook

Updates the definition of an existing webhook.

Http request

PUT /webhooks/{webhookId}

Required permissions

Webhooks:Update (always required)

Authentication

Authentication Type	Supported
Organization User (CustomerEmployee)	Yes
Delegated User (EndUser)	No
Service Account	Yes

Authorization

Header	Type	Required	Description
Authorization	string	Yes	Bearer token used to authenticate the request. See Authentication flows for instructions on generating this token.
X-DFNS-USERACTION	string	Yes	User action signature used to sign change-inducing requests. See User Action Signing flows for details on generating this signature.

Path parameter

Parameter	Type	Required	Description
webhookId	string	Yes	Unique identifier of the webhook to update. Minimum length is 1.

Request body

Field	Type	Required	Description
url	string	No	Webhook URL.
description	string	No	Short description of the webhook’s purpose. Maximum length is 256 characters.
events	array of strings	No	Events this webhook is subscribed to. Supports specific event names or `*` for all events. Minimum of 1 item if provided.
status	string	No	Webhook status. Valid values: `Enabled`, `Disabled`.

curl --request PUT \
  --url https://api.digitalassets.ibm.com/webhooks/{webhookId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-DFNS-USERACTION: <api-key>' \
  --data '
{
  "url": "<string>",
  "description": "<string>",
  "events": [
    "policy.triggered"
  ],
  "status": "Enabled"
}
'

Response

200: Success

{
  "id": "<string>",
  "url": "<string>",
  "events": [
    "policy.triggered"
  ],
  "status": "Enabled",
  "dateCreated": "<string>",
  "dateUpdated": "<string>",
  "description": "<string>"
}