Skip to main content
POST
Queue one sample competitor_monitoring.alert to your webhook, with the same headers, signature and retries as real alerts. The sample is an attack_critical_comment with made-up values and "test": true, and a fresh alert_id each time. See Webhook payloads. The call answers once the request is queued; your endpoint receives it within a few seconds. Admin only. Optional. Without a body, the saved webhook_url and secret are used.

Response

A workspace with no URL saved and none sent gets a 400.

Authorizations

Authorization
string
header
required

The API key you created on the API settings page of the Clustr app.

Body

application/json
webhook_url
string<uri>

Test this URL in place of the saved one, for example before you save it. It must start with https:// or http:// and name a host.

Maximum string length: 2048
Example:

"https://hooks.example.com/clustr"

webhook_secret
string
write-only

Sign the sample with this secret in place of the saved one. An empty string sends the sample unsigned.

Example:

"whsec_example"

Response

The sample is queued

success
boolean
required
Example:

true

data
object
required