CentralCSP
APIAlerts

List alert deliveries

Shows what was actually sent, newest first, with the channel, the number of attempts, and the upstream response. Use it to work out why a notification never arrived. Filter by rule, 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.

channelId?string

Only deliveries to this channel.

status?||

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

Response Body

application/json

curl -X GET "https://api-next.centralcsp.com/v1/workspaces/string/websites/string/alerts/deliveries?limit=50"
{  "data": [    {      "id": "string",      "eventId": "string",      "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  }}