Webhook Events

List webhook events

GET /webhook-events

Code samples

curl -X GET https://localhost:9543/api/v0.9/webhook-events \
  -u {username}:{password} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Returns a paginated list of webhook events for the organization. Each event includes a summary of its delivery rows. Requires dp:event_read scope.

Authentication

Parameters

Name	In	Type	Required	Description
status	query	string	false	Filter events by status.
limit	query	integer	false	Maximum number of records to return.
offset	query	integer	false	Number of records to skip before returning results.

Enumerated Values

Parameter	Value
status	PENDING
status	DISPATCHED
status	ALL_DELIVERED
status	FAILED

Example responses

200 Response

{
  "list": [
    {
      "eventId": "evt-abc123",
      "eventType": "apikey.generated",
      "orgId": "org-default",
      "aggregateType": "apikey",
      "aggregateId": "key-12345",
      "status": "ALL_DELIVERED",
      "occurredAt": "2019-08-24T14:15:22Z",
      "deliveries": [
        {
          "deliveryId": "del-abc123",
          "subscriberId": "sub-xyz789",
          "targetUrl": "https://example.com/webhook",
          "status": "DELIVERED",
          "lastHttpStatus": 200,
          "lastError": "string",
          "lastAttemptAt": "2019-08-24T14:15:22Z",
          "deliveredAt": "2019-08-24T14:15:22Z"
        }
      ]
    }
  ],
  "count": 1,
  "pagination": {
    "total": 42,
    "limit": 20,
    "offset": 0
  }
}

403 Response

{
  "status": "error",
  "code": "FORBIDDEN",
  "message": "Write operations are disabled in read-only mode."
}

500 Response

{
  "status": "error",
  "code": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred."
}

Responses

Status	Meaning	Description	Schema
200	OK	Paginated list of webhook events.	Inline
403	Forbidden	Request is forbidden for the current runtime mode or caller permissions.	ErrorResponse
500	Internal Server Error	Internal server error.	ErrorResponse

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» list	[WebhookEvent]	false	none	[A webhook event with its delivery rows.]
»» eventId	string	false	none	none
»» eventType	string	false	none	none
»» orgId	string	false	none	none
»» aggregateType	string	false	none	none
»» aggregateId	string	false	none	none
»» status	string	false	none	none
»» occurredAt	string(date-time)	false	none	none
»» deliveries	[WebhookEventDelivery]	false	none	[A single webhook delivery attempt.]
»»» deliveryId	string	false	none	none
»»» subscriberId	string	false	none	none
»»» targetUrl	string¦null	false	none	none
»»» status	string	false	none	none
»»» lastHttpStatus	integer¦null	false	none	none
»»» lastError	string¦null	false	none	none
»»» lastAttemptAt	string(date-time)¦null	false	none	none
»»» deliveredAt	string(date-time)¦null	false	none	none
» count	integer	false	none	Number of items returned in this page.
» pagination	Pagination	false	none	Standard pagination metadata returned with collection responses.
»» total	integer	true	none	Total number of records matching the query.
»» limit	integer	true	none	Maximum number of records returned in this response.
»» offset	integer	true	none	Number of records skipped before this page.

Enumerated Values

Property	Value
status	PENDING
status	DISPATCHED
status	ALL_DELIVERED
status	FAILED
status	PENDING
status	IN_FLIGHT
status	DELIVERED
status	FAILED

Get a webhook event

GET /webhook-events/{eventId}

Code samples

curl -X GET https://localhost:9543/api/v0.9/webhook-events/{eventId} \
  -u {username}:{password} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Returns a single webhook event with the full details of all its delivery rows. Requires dp:event_read scope.

Authentication

Parameters

Name	In	Type	Required	Description
eventId	path	string	true	Webhook event identifier.

Example responses

200 Response

{
  "eventId": "evt-abc123",
  "eventType": "apikey.generated",
  "orgId": "org-default",
  "aggregateType": "apikey",
  "aggregateId": "key-12345",
  "status": "ALL_DELIVERED",
  "occurredAt": "2019-08-24T14:15:22Z",
  "deliveries": [
    {
      "deliveryId": "del-abc123",
      "subscriberId": "sub-xyz789",
      "targetUrl": "https://example.com/webhook",
      "status": "DELIVERED",
      "lastHttpStatus": 200,
      "lastError": "string",
      "lastAttemptAt": "2019-08-24T14:15:22Z",
      "deliveredAt": "2019-08-24T14:15:22Z"
    }
  ]
}

403 Response

{
  "status": "error",
  "code": "FORBIDDEN",
  "message": "Write operations are disabled in read-only mode."
}

404 Response

{
  "status": "error",
  "code": "ORG_NOT_FOUND",
  "message": "Organization not found."
}

500 Response

{
  "status": "error",
  "code": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred."
}

Responses

Status	Meaning	Description	Schema
200	OK	Single webhook event with full delivery details.	WebhookEvent
403	Forbidden	Request is forbidden for the current runtime mode or caller permissions.	ErrorResponse
404	Not Found	Resource not found.	ErrorResponse
500	Internal Server Error	Internal server error.	ErrorResponse