Update Delivery Config

PUT

competitor-monitoring

delivery-config

curl -X PUT https://api.clustr-ai.com/api/public/competitor-monitoring/delivery-config \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email_enabled": true,
    "extra_recipients": ["gtm@yourcompany.com"],
    "slack_enabled": true,
    "slack_channel_id": "C0123456789",
    "webhook_enabled": true,
    "webhook_url": "https://hooks.yourcompany.com/clustr/competitors",
    "routes": [
      { "scope": "in_crm", "label": "CS team", "slack_enabled": true, "slack_channel_id": "C0CSCHANNEL" },
      { "scope": "open_deal", "label": "AEs", "slack_enabled": true, "slack_channel_id": "C0AECHANNEL" }
    ]
  }'

import requests

requests.put(
    "https://api.clustr-ai.com/api/public/competitor-monitoring/delivery-config",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={
        "email_enabled": True,
        "slack_enabled": True,
        "slack_channel_id": "C0123456789",
    },
)

await fetch("https://api.clustr-ai.com/api/public/competitor-monitoring/delivery-config", {
  method: "PUT",
  headers: { Authorization: "Bearer YOUR_API_KEY", "Content-Type": "application/json" },
  body: JSON.stringify({
    email_enabled: true,
    slack_enabled: true,
    slack_channel_id: "C0123456789",
  }),
});

{
  "success": true,
  "data": {
    "email_enabled": true,
    "extra_recipients": ["gtm@yourcompany.com"],
    "slack_enabled": true,
    "slack_channel_id": "C0123456789",
    "webhook_enabled": true,
    "webhook_url": "https://hooks.yourcompany.com/clustr/competitors",
    "routes": [
      { "scope": "in_crm", "label": "CS team", "slack_enabled": true, "slack_channel_id": "C0CSCHANNEL" },
      { "scope": "open_deal", "label": "AEs", "slack_enabled": true, "slack_channel_id": "C0AECHANNEL" }
    ]
  }
}

Set where finished competitor reports are delivered. See the webhook payload for what a competitor_monitoring.report_ready event contains.

curl -X PUT https://api.clustr-ai.com/api/public/competitor-monitoring/delivery-config \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email_enabled": true,
    "extra_recipients": ["gtm@yourcompany.com"],
    "slack_enabled": true,
    "slack_channel_id": "C0123456789",
    "webhook_enabled": true,
    "webhook_url": "https://hooks.yourcompany.com/clustr/competitors",
    "routes": [
      { "scope": "in_crm", "label": "CS team", "slack_enabled": true, "slack_channel_id": "C0CSCHANNEL" },
      { "scope": "open_deal", "label": "AEs", "slack_enabled": true, "slack_channel_id": "C0AECHANNEL" }
    ]
  }'

import requests

requests.put(
    "https://api.clustr-ai.com/api/public/competitor-monitoring/delivery-config",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={
        "email_enabled": True,
        "slack_enabled": True,
        "slack_channel_id": "C0123456789",
    },
)

await fetch("https://api.clustr-ai.com/api/public/competitor-monitoring/delivery-config", {
  method: "PUT",
  headers: { Authorization: "Bearer YOUR_API_KEY", "Content-Type": "application/json" },
  body: JSON.stringify({
    email_enabled: true,
    slack_enabled: true,
    slack_channel_id: "C0123456789",
  }),
});

{
  "success": true,
  "data": {
    "email_enabled": true,
    "extra_recipients": ["gtm@yourcompany.com"],
    "slack_enabled": true,
    "slack_channel_id": "C0123456789",
    "webhook_enabled": true,
    "webhook_url": "https://hooks.yourcompany.com/clustr/competitors",
    "routes": [
      { "scope": "in_crm", "label": "CS team", "slack_enabled": true, "slack_channel_id": "C0CSCHANNEL" },
      { "scope": "open_deal", "label": "AEs", "slack_enabled": true, "slack_channel_id": "C0AECHANNEL" }
    ]
  }
}

Authorizations

Authorization

string

header

required

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

Body

application/json

email_enabled

boolean

Send the report summary by email.

notify_admins

boolean

Also email the report to your workspace admins, on top of extra_recipients, while email_enabled is true. When you leave it out, the admins receive the report if extra_recipients is empty, and only the addresses in extra_recipients receive it otherwise.

Example:

true

extra_recipients

string[]

Additional email recipients beyond your workspace's default.

slack_enabled

boolean

Post a one-line summary to Slack.

slack_channel_id

string

Slack channel id to post to. Requires a connected Slack workspace.

webhook_enabled

boolean

POST a competitor_monitoring.report_ready event when a report is ready.

webhook_url

string

Your endpoint for that event.

routes

object[]

Destinations for each audience. When you leave it out, the channels above receive the whole digest. With routes, each route receives only its own slice, so your CS channel can follow the accounts you already own while your SDRs follow the prospects they are working.

The scopes split the accounts between them, so each account is delivered once.

Show child attributes

Response

The saved delivery config

success

boolean

required

Example:

true

data

object

required

curl -X PUT https://api.clustr-ai.com/api/public/competitor-monitoring/delivery-config \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email_enabled": true,
    "extra_recipients": ["gtm@yourcompany.com"],
    "slack_enabled": true,
    "slack_channel_id": "C0123456789",
    "webhook_enabled": true,
    "webhook_url": "https://hooks.yourcompany.com/clustr/competitors",
    "routes": [
      { "scope": "in_crm", "label": "CS team", "slack_enabled": true, "slack_channel_id": "C0CSCHANNEL" },
      { "scope": "open_deal", "label": "AEs", "slack_enabled": true, "slack_channel_id": "C0AECHANNEL" }
    ]
  }'

import requests

requests.put(
    "https://api.clustr-ai.com/api/public/competitor-monitoring/delivery-config",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={
        "email_enabled": True,
        "slack_enabled": True,
        "slack_channel_id": "C0123456789",
    },
)

await fetch("https://api.clustr-ai.com/api/public/competitor-monitoring/delivery-config", {
  method: "PUT",
  headers: { Authorization: "Bearer YOUR_API_KEY", "Content-Type": "application/json" },
  body: JSON.stringify({
    email_enabled: true,
    slack_enabled: true,
    slack_channel_id: "C0123456789",
  }),
});

{
  "success": true,
  "data": {
    "email_enabled": true,
    "extra_recipients": ["gtm@yourcompany.com"],
    "slack_enabled": true,
    "slack_channel_id": "C0123456789",
    "webhook_enabled": true,
    "webhook_url": "https://hooks.yourcompany.com/clustr/competitors",
    "routes": [
      { "scope": "in_crm", "label": "CS team", "slack_enabled": true, "slack_channel_id": "C0CSCHANNEL" },
      { "scope": "open_deal", "label": "AEs", "slack_enabled": true, "slack_channel_id": "C0AECHANNEL" }
    ]
  }
}

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

Update Delivery Config

Authorizations

Body

Response