CentralCSP
APIAlerts

Send a test alert

Sends a sample notification through the channel right away and reports what happened. Use it to check a webhook URL or chat integration before you rely on it. A failed send returns ok: false with the upstream status rather than an error status.

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

POST
/v1/workspaces/{workspaceId}/websites/{websiteId}/alerts/channels/{channelId}/test

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
channelId*string

Response Body

application/json

curl -X POST "https://api-next.centralcsp.com/v1/workspaces/string/websites/string/alerts/channels/string/test"
{  "ok": true,  "status": 0,  "error": "string"}