Get Competitor Alerts

GET

notifications

competitor-alerts

curl "https://api.clustr-ai.com/api/public/notifications/competitor-alerts?account=acc_0v7tgcp9dspw8x9zc6teb5qx8z" \
  -H "Authorization: Bearer YOUR_API_KEY"

import requests

requests.get(
    "https://api.clustr-ai.com/api/public/notifications/competitor-alerts",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    params={"account": "acc_0v7tgcp9dspw8x9zc6teb5qx8z"},
)

await fetch("https://api.clustr-ai.com/api/public/notifications/competitor-alerts?account=acc_0v7tgcp9dspw8x9zc6teb5qx8z", {
  headers: { Authorization: "Bearer YOUR_API_KEY" },
});

{
  "success": true,
  "data": {
    "enabled": true,
    "attack_slack_channel_id": "C0123456789",
    "defense_slack_channel_id": "C0987654321",
    "attack_email_enabled": true,
    "defense_email_enabled": false,
    "attack_email_recipients": ["sales-leads@example.com"],
    "defense_email_recipients": [],
    "webhook_enabled": true,
    "webhook_url": "https://hooks.example.com/clustr",
    "has_webhook_secret": true,
    "attack_threshold_interactions": 10,
    "attack_threshold_days": 30,
    "attack_threshold_scope": "per_competitor",
    "alert_history_days": 14,
    "has_delivery": true,
    "customers": true,
    "targets": true,
    "attack_other_accounts": true,
    "is_default": false,
    "updated_at": "2026-10-08T09:12:44Z",
    "customer_rule": { "summary": "Won deals in HubSpot and your client list", "count": 14 },
    "account": {
      "name": "Initech",
      "owner": {
        "clustr_user_id": "usr_6h0tgfv0qq26twwzng1g624dt6",
        "user_id": "3f7a9d2e-0c4b-4e1f-8a6d-5b2c9e1f0a47",
        "email": "marine.b@example.com",
        "name": "Marine B"
      },
      "owner_source": "crm_owner",
      "recipients": ["marine.b@example.com", "sales-leads@example.com"]
    }
  }
}

Read the competitor alert setting: whether alerts go out, the Slack channel and the email for each use case, the webhook, the Attack threshold and its scope, and how far back a single interaction still alerts. Change it with Update Competitor Alerts. Each alert is sent on its own. A Defense alert (an interaction on one of your customers) posts in defense_slack_channel_id and names the account’s CS owner; an Attack alert (a critical comment, or an account over the threshold, on a non-customer) posts in attack_slack_channel_id and names the account’s owner. Both owners come from the fields you map in your CRM, read live when the alert is sent; with no owner, the alert names nobody. When email is on for a use case, each alert is also emailed to its owner and to that use case’s extra addresses. When the webhook is on, every alert is also POSTed to webhook_url; see Webhook payloads.

On, with nowhere to send yet. A workspace that never saved the setting reads as enabled: true, for customers and target accounts, with the threshold at 10 interactions in 30 days per competitor, a 14-day history window, no channel, no email and no webhook, and is_default: true. has_delivery is false until a channel, an email or the webhook is set: until then, no alert is sent.

Field	Description
`enabled`	Whether alerts go out at all
`attack_slack_channel_id`	The Slack channel Attack alerts post in, or `null`
`defense_slack_channel_id`	The Slack channel Defense alerts post in, or `null`. May be the same as Attack
`attack_email_enabled`	Whether each Attack alert is emailed to the account owner and `attack_email_recipients`
`defense_email_enabled`	Whether each Defense alert is emailed to the CS owner and `defense_email_recipients`
`attack_email_recipients`	Extra addresses that get every Attack alert by email
`defense_email_recipients`	Extra addresses that get every Defense alert by email
`webhook_enabled`	Whether every alert is also POSTed to `webhook_url`
`webhook_url`	The webhook endpoint, or `null`
`has_webhook_secret`	Whether a signing secret is saved. The secret itself is never returned
`attack_threshold_interactions`	An Attack account alerts at this many interactions or more
`attack_threshold_days`	…over this many days
`attack_threshold_scope`	`per_competitor`: counted with each competitor on its own. `all_competitors`: with all your competitors together
`alert_history_days`	A Defense interaction or a critical comment alerts only if it happened within this many days
`has_delivery`	`false` when there is no channel, no email and no webhook: alerts are not sent
`customers`	Defense alerts on (one of your customers)
`targets`	Attack alerts on (an account that is not a customer). Each Attack alert says whether its account is a target account or an other account
`attack_other_accounts`	`true` (default): Attack also alerts on other accounts, the non-customers that are not on your target account list, labelled “Other account”. `false`: target accounts only
`customer_rule`	Who counts as a customer, in one line: your client list

curl "https://api.clustr-ai.com/api/public/notifications/competitor-alerts?account=acc_0v7tgcp9dspw8x9zc6teb5qx8z" \
  -H "Authorization: Bearer YOUR_API_KEY"

import requests

requests.get(
    "https://api.clustr-ai.com/api/public/notifications/competitor-alerts",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    params={"account": "acc_0v7tgcp9dspw8x9zc6teb5qx8z"},
)

await fetch("https://api.clustr-ai.com/api/public/notifications/competitor-alerts?account=acc_0v7tgcp9dspw8x9zc6teb5qx8z", {
  headers: { Authorization: "Bearer YOUR_API_KEY" },
});

{
  "success": true,
  "data": {
    "enabled": true,
    "attack_slack_channel_id": "C0123456789",
    "defense_slack_channel_id": "C0987654321",
    "attack_email_enabled": true,
    "defense_email_enabled": false,
    "attack_email_recipients": ["sales-leads@example.com"],
    "defense_email_recipients": [],
    "webhook_enabled": true,
    "webhook_url": "https://hooks.example.com/clustr",
    "has_webhook_secret": true,
    "attack_threshold_interactions": 10,
    "attack_threshold_days": 30,
    "attack_threshold_scope": "per_competitor",
    "alert_history_days": 14,
    "has_delivery": true,
    "customers": true,
    "targets": true,
    "attack_other_accounts": true,
    "is_default": false,
    "updated_at": "2026-10-08T09:12:44Z",
    "customer_rule": { "summary": "Won deals in HubSpot and your client list", "count": 14 },
    "account": {
      "name": "Initech",
      "owner": {
        "clustr_user_id": "usr_6h0tgfv0qq26twwzng1g624dt6",
        "user_id": "3f7a9d2e-0c4b-4e1f-8a6d-5b2c9e1f0a47",
        "email": "marine.b@example.com",
        "name": "Marine B"
      },
      "owner_source": "crm_owner",
      "recipients": ["marine.b@example.com", "sales-leads@example.com"]
    }
  }
}

Authorizations

Authorization

string

header

required

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

Query Parameters

account

string

Optional. An account's Clustr ID (acc_…); its LinkedIn numeric id also works. Also returns account: the owner an Attack alert on it names (its owner in your CRM, from the last CRM sync), with owner_source crm_owner, or owner: null and owner_source: "none" when your CRM names nobody. recipients lists who an Attack alert on it is emailed to when Attack email is on.

Response

The current setting

success

boolean

required

Example:

true

data

object

required

Show child attributes

curl "https://api.clustr-ai.com/api/public/notifications/competitor-alerts?account=acc_0v7tgcp9dspw8x9zc6teb5qx8z" \
  -H "Authorization: Bearer YOUR_API_KEY"

import requests

requests.get(
    "https://api.clustr-ai.com/api/public/notifications/competitor-alerts",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    params={"account": "acc_0v7tgcp9dspw8x9zc6teb5qx8z"},
)

await fetch("https://api.clustr-ai.com/api/public/notifications/competitor-alerts?account=acc_0v7tgcp9dspw8x9zc6teb5qx8z", {
  headers: { Authorization: "Bearer YOUR_API_KEY" },
});

{
  "success": true,
  "data": {
    "enabled": true,
    "attack_slack_channel_id": "C0123456789",
    "defense_slack_channel_id": "C0987654321",
    "attack_email_enabled": true,
    "defense_email_enabled": false,
    "attack_email_recipients": ["sales-leads@example.com"],
    "defense_email_recipients": [],
    "webhook_enabled": true,
    "webhook_url": "https://hooks.example.com/clustr",
    "has_webhook_secret": true,
    "attack_threshold_interactions": 10,
    "attack_threshold_days": 30,
    "attack_threshold_scope": "per_competitor",
    "alert_history_days": 14,
    "has_delivery": true,
    "customers": true,
    "targets": true,
    "attack_other_accounts": true,
    "is_default": false,
    "updated_at": "2026-10-08T09:12:44Z",
    "customer_rule": { "summary": "Won deals in HubSpot and your client list", "count": 14 },
    "account": {
      "name": "Initech",
      "owner": {
        "clustr_user_id": "usr_6h0tgfv0qq26twwzng1g624dt6",
        "user_id": "3f7a9d2e-0c4b-4e1f-8a6d-5b2c9e1f0a47",
        "email": "marine.b@example.com",
        "name": "Marine B"
      },
      "owner_source": "crm_owner",
      "recipients": ["marine.b@example.com", "sales-leads@example.com"]
    }
  }
}

API Reference

Import

Search

Jobs

Network

Opportunities

Owners

Accounts

Account States

Saved Views

Workflows

Intro Requests

Notes

Record Activity

Tags

Target Accounts

Client Companies

Excluded Companies

Buyer Titles

ICP

Competitor Monitoring

Connector Refresh

Notifications

Get Competitor Alerts

Authorizations

Query Parameters

Response