List Webhook Events

Edit online

Lists all recorded events for a specific webhook.

Note: Webhook events are retained for 31 days only. After that period, they are permanently removed and cannot be retrieved using either List Webhook Events or Get Webhook Event.
Http request
GET /webhooks/{webhookId}/events
Authentication
Authentication Type Supported
Organization User (CustomerEmployee) Yes
Delegated User (EndUser) No
Service Account Yes
Required permissions
Webhooks:Events:Read (always required)
Authorization requirements
Header Type Required Description
Authorization string Yes Bearer token used to authenticate the request. See Authentication flows for instructions on generating this token.
Query parameters
Parameter Type Required
kind string No
deliveryFailed string No
limit integer No
paginationToken string No
Request body
curl --request GET \
  --url https://api.digitalassets.ibm.com/webhooks/{webhookId}/events \
  --header 'Authorization: Bearer <token>'
Response
200: Success

Example response:

{
  "items": [
    {
      "id": "<string>",
      "date": "<string>",
      "kind": "policy.triggered",
      "data": {},
      "status": "<string>",
      "timestampSent": 123,
      "error": "<string>"
    }
  ],
  "nextPageToken": "<string>"
}