Create Webhook

Registers a new webhook for the authenticated user’s organization.

Http request

POST /webhooks

Required permissions

Webhooks:Create (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 instructions on generating this signature.

Request body

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

curl --request GET \
  --url https://api.digitalassets.ibm.com/webhooks/{webhookId} \
  --header 'Authorization: Bearer <token>'

Response

200: Success

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