CentralCSP
APIAlerts

List alert deliveries

Shows what was actually sent, newest first: the rule that triggered it, what that rule was watching for, the channel, the number of attempts, and the upstream response. Use it to work out why a notification never arrived. Filter by rule, event type, channel, or status.

Requires the viewer role on the website and the alerting plan feature.

GET
/v1/workspaces/{workspaceId}/websites/{websiteId}/alerts/deliveries

Authorization

AuthorizationBearer <token>

An OpenID Connect access token issued by Keycloak, acting as the signed-in user.

In: header

Path Parameters

workspaceId*string
websiteId*string

Query Parameters

cursor?string

The nextCursor of the previous page. Omit it to start from the beginning. A cursor encodes a position and is not meant to be built by hand.

limit*|

How many items to return, from 1 to 200.

Range1 <= value <= 200
Default50
ruleId?string

Only deliveries produced by this rule.

eventType?AlertEventType

What to notify about. new-* types fire the first time something appears in a website's reports: a CSP directive and blocked origin pair, a script origin, a failing network origin, a COOP or COEP violation type, a Permissions Policy violation, a deprecated API, a browser intervention, or a blocked connection origin. compliance:unjustified-script fires when a payment-page script needs review. *:spike types fire when an hour's report volume reaches at least 50 reports and three times the trailing 24-hour average, both adjustable per rule with config. sbom:new-cve fires when a technology on the website gains a known vulnerability at or above the rule's minimum severity; sbom:version-status fires when a technology is detected as, or becomes, outdated or deprecated, per the rule's statuses.

Value in

  • "csp-violation:new-type"
  • "csp-violation:spike"
  • "csp-hash:new-script-origin"
  • "integrity-violation:spike"
  • "compliance:unjustified-script"
  • "network-error:new-failing-origin"
  • "network-error:spike"
  • "crash:spike"
  • "coop:new-violation"
  • "coep:new-violation"
  • "permissions-policy:new-violation"
  • "deprecation:new-api"
  • "intervention:new-type"
  • "connection-allowlist:new-blocked-origin"
  • "sbom:new-cve"
  • "sbom:version-status"
channelId?string

Only deliveries to this channel.

status?AlertDeliveryStatus

pending is queued or being retried, delivered succeeded, failed gave up.

Value in

  • "pending"
  • "delivered"
  • "failed"

Response Body

application/json

curl -X GET "https://example.com/v1/workspaces/string/websites/string/alerts/deliveries?limit=50"
{  "data": [    {      "id": "string",      "eventId": "string",      "ruleId": "string",      "ruleName": "New third-party script",      "eventType": "csp-hash:new-script-origin",      "channelId": "string",      "channelType": "string",      "channelName": "string",      "status": "pending",      "attempts": 0,      "responseStatus": 0,      "error": "string",      "createdAt": "2019-08-24T14:15:22Z",      "completedAt": "2019-08-24T14:15:22Z"    }  ],  "pagination": {    "nextCursor": "string",    "hasMore": true,    "total": 0  }}