Ping Webhook

Edit online

Triggers a test event and sends it to the webhook URL associated with the specified webhook. This endpoint is used for webhook setup and troubleshooting. The test event is not stored and does not appear in Webhook Events.

Http request

POST /webhooks/{webhookId}/ping

Required permissions

Webhooks:Ping: 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.

Path parameter

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

Request body

curl --request POST \
  --url https://api.digitalassets.ibm.com/webhooks/{webhookId}/ping \
  --header 'Authorization: Bearer <token>' \
  --header 'X-DFNS-USERACTION: <api-key>'

Response

200: Success

{
  "status": "<string>",
  "error": "<string>"
}