Skip to main content
PUT
Turn competitor alerts on or off, and for Attack and for Defense pick the Slack channel and whether each alert is emailed. Set up the webhook, the Attack threshold and its scope, and how far back a single interaction still alerts. Each alert type has its own rule: the interactions that count (*_interaction_kinds), the minimum people engaged at the account (*_min_people), the period (*_period_days), and whether a single comment in the period is enough on its own (*_comment_alone). An account alerts once per monitoring run, listing every person engaged, when it meets the rule and someone new was engaged. Each alert is posted in its use case’s channel, naming the owner from your CRM (the account owner for Attack, the CS owner for Defense, read live when the alert is sent, nobody when the field is empty), emailed to that owner and the use case’s extra addresses when email is on, and POSTed to the webhook when it is on. Send only the fields you want to change; a field you leave out keeps its saved value. Admin only.
No channel, no email and no webhook means no alerts. Saving with none is allowed, and the response says so with has_delivery: false. With email on but no owner in your CRM and no extra address, that alert is not emailed.

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
enabled
boolean

Whether competitor alerts go out. false stops every Slack post, email, webhook call and team refresh recap.

​
attack_slack_channel_id
string

The Slack channel Attack alerts post in, as a Slack channel id such as C0123456789. An empty string clears it.

​
defense_slack_channel_id
string

The Slack channel Defense alerts post in. May be the same as the Attack channel. An empty string clears it.

​
attack_email_enabled
boolean

Email each Attack alert to the account owner from your CRM and to attack_email_recipients.

​
defense_email_enabled
boolean

Email each Defense alert to the CS owner from your CRM and to defense_email_recipients.

​
attack_email_recipients
string<email>[]

Extra addresses that get every Attack alert by email, at most 50. Replaces the saved list; an empty list clears it. An address without an @ is a 400.

Maximum array length: 50
​
defense_email_recipients
string<email>[]

Extra addresses that get every Defense alert by email, at most 50. Replaces the saved list.

Maximum array length: 50
​
webhook_enabled
boolean

Sends every alert and every team refresh recap to webhook_url as a POST request. Requires webhook_url; without one the call answers 400.

​
webhook_url
string

The endpoint, https:// (or http://) with a host, at most 2048 characters. An empty string clears it. See Webhook payloads.

​
webhook_secret
string
write-only

The secret that signs each request with X-ClustR-Signature. It is write-only: the response reports has_webhook_secret in its place. Leave it out to keep the saved secret; an empty string removes it. At most 256 characters.

​
attack_threshold_interactions
integer

An account that is not a customer alerts when it has at least this many interactions over attack_threshold_days. From 1 to 10000. Default 10.

Required range: 1 <= x <= 10000
​
attack_threshold_days
integer

The period the threshold counts over, in days. From 1 to 365. Default 30.

Required range: 1 <= x <= 365
​
attack_threshold_scope
enum<string>

per_competitor (default) counts an account's interactions with each competitor's team on its own. all_competitors counts them across all your competitors together; the alert then names the most active one.

Available options:
per_competitor,
all_competitors
​
alert_history_days
integer

How old a Defense interaction or a critical comment may be and still alert, in days. From 1 to 365. Default 14. Older activity still appears in every view without alerting.

Required range: 1 <= x <= 365
​
customers
boolean

Defense alerts: interactions on one of your customers.

​
targets
boolean

Attack alerts: critical comments and threshold alerts on accounts that are not customers, both your target accounts and every other account a competitor engages with. Each alert is labelled "Target account" or "Other account" (account_scope in the webhook).

​
attack_other_accounts
boolean

true (default) keeps the Attack alerts on other accounts, the non-customers that are not on your target account list. false mutes them: Attack then alerts on your target accounts only.

​
defense_interaction_kinds
enum<string>[]

Defense alerts: the interactions that count, comment and/or like. Default both.

Available options:
comment,
like
​
attack_interaction_kinds
enum<string>[]

Attack alerts: the interactions that count, comment and/or like. Default both.

Available options:
comment,
like
​
defense_min_people
integer

Defense alerts: an account alerts once this many people there were engaged in the period. Default 2.

​
attack_min_people
integer

Attack alerts: an account alerts once this many people there were engaged in the period. Default 2.

​
defense_period_days
integer

Defense alerts: the period the people engaged are counted over, in days (1 to 365). Default 30.

​
attack_period_days
integer

Attack alerts: the period the people engaged are counted over, in days (1 to 365). Default 30.

​
defense_comment_alone
boolean

Defense alerts: a comment is enough. An account also alerts when one comment there falls in the period, below defense_min_people.

​
attack_comment_alone
boolean

Attack alerts: a comment is enough. An account also alerts when one comment there falls in the period, below attack_min_people.

​
notify_defaults
boolean
​
slack_dm
boolean
​
slack_channel_id
string
​
recipients
string<email>[]

Response

The saved setting

​
success
boolean
required
Example:

true

​
data
object
required