Integrations

Watch a Discord server under a keyword

Files every message of a connected server (or of channelIds) under the keyword, without a text match. Uses no keyword slot. The keyword must be a TEXT keyword of this workspace (400 DISCORD_KEYWORD_NOT_TEXT for a review source, 404 KEYWORD_NOT_FOUND otherwise); a keyword watches a server once (409 DISCORD_MONITOR_EXISTS). Omit dailyCap for the plan default, clamp(round(0.02 × monthly mentions), 25, 500) — 100 on the free trial; an explicit cap may be 1–2000. Every channelIds entry must be a readable channel of the server inside its channel scope (400 DISCORD_CHANNEL_INVALID). Requires an admin-scoped key; 403 DISCORD_SOURCE_UNAVAILABLE while the Discord source is not enabled for the workspace.

POST

api

integrations

discord

monitors

Watch a Discord server under a keyword

curl --request POST \
  --url https://app.octolens.com/api/v2/integrations/discord/monitors \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "keywordId": 101,
  "linkId": 12,
  "channelIds": [],
  "dailyCap": 100
}
'

import requests

url = "https://app.octolens.com/api/v2/integrations/discord/monitors"

payload = {
    "keywordId": 101,
    "linkId": 12,
    "channelIds": [],
    "dailyCap": 100
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({keywordId: 101, linkId: 12, channelIds: [], dailyCap: 100})
};

fetch('https://app.octolens.com/api/v2/integrations/discord/monitors', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.octolens.com/api/v2/integrations/discord/monitors",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'keywordId' => 101,
    'linkId' => 12,
    'channelIds' => [
        
    ],
    'dailyCap' => 100
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.octolens.com/api/v2/integrations/discord/monitors"

	payload := strings.NewReader("{\n  \"keywordId\": 101,\n  \"linkId\": 12,\n  \"channelIds\": [],\n  \"dailyCap\": 100\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.octolens.com/api/v2/integrations/discord/monitors")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"keywordId\": 101,\n  \"linkId\": 12,\n  \"channelIds\": [],\n  \"dailyCap\": 100\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.octolens.com/api/v2/integrations/discord/monitors")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"keywordId\": 101,\n  \"linkId\": 12,\n  \"channelIds\": [],\n  \"dailyCap\": 100\n}"

response = http.request(request)
puts response.read_body

{
  "id": 0,
  "linkId": 0,
  "guildId": "1290000000000000200",
  "keywordId": 0,
  "channelIds": [
    "1290000000000000200"
  ],
  "status": "active",
  "dailyCap": 0,
  "todayCount": 0,
  "lastErrorCode": "<string>",
  "estimatedMonthlyMentions": 0,
  "createdAt": "2026-10-28T12:00:00.000Z",
  "updatedAt": "2026-10-28T12:00:00.000Z"
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

Authorizations

Authorization

string

header

required

Clerk API key. Create one in Settings → API Keys. Pass as Authorization: Bearer <key>. Keys carry a scope — read, write (implies read) or admin (implies write) — chosen when the key is minted. Each operation's security requirement (and its x-required-scope extension) names the minimum scope it needs; request the least-privileged key that covers the operations you call.

Body

application/json

keywordId

integer

required

The parent TEXT keyword the server's messages are filed under. Uses no keyword slot.

Required range: x <= 9007199254740991

Example:

101

linkId

integer

required

The connected server's link id (DiscordServer.linkId).

Required range: x <= 9007199254740991

Example:

12

channelIds

string[]

Channels to watch; omit or [] for every channel the server link reads. Each id must be a readable channel of the server and inside its channel scope.

Maximum array length: 500

A Discord snowflake id as a decimal string (64-bit — never parse it as a number).

Pattern: ^\d{1,20}$

Example:

[]

dailyCap

integer

Posts per UTC day (1–2000). Omit for the plan default: clamp(round(0.02 × monthly mentions), 25, 500) — 100 on the free trial.

Required range: 1 <= x <= 2000

Example:

100

Response

200 response

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

linkId

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

guildId

string

required

A Discord snowflake id as a decimal string (64-bit — never parse it as a number).

Pattern: ^\d{1,20}$

Example:

"1290000000000000200"

keywordId

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

channelIds

string[]

required

Watched channel ids; [] = every channel the server link reads.

A Discord snowflake id as a decimal string (64-bit — never parse it as a number).

Pattern: ^\d{1,20}$

status

enum<string>

required

paused: paused by an admin. paused_bot_removed: waits for the bot to be re-added to the server, then resumes on its own.

Available options:

active,

paused,

paused_bot_removed

dailyCap

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

todayCount

integer

required

Posts created so far this UTC day.

Required range: -9007199254740991 <= x <= 9007199254740991

lastErrorCode

string | null

required

e.g. missing_access when the bot can read none of the watched channels.

estimatedMonthlyMentions

integer | null

required

Expected mentions per month at this monitor's cap; null = unknown (no stats yet).

Required range: -9007199254740991 <= x <= 9007199254740991

createdAt

string

required

Example:

"2026-10-28T12:00:00.000Z"

updatedAt

string

required

Example:

"2026-10-28T12:00:00.000Z"

Watch a Discord server under a keyword

curl --request POST \
  --url https://app.octolens.com/api/v2/integrations/discord/monitors \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "keywordId": 101,
  "linkId": 12,
  "channelIds": [],
  "dailyCap": 100
}
'

import requests

url = "https://app.octolens.com/api/v2/integrations/discord/monitors"

payload = {
    "keywordId": 101,
    "linkId": 12,
    "channelIds": [],
    "dailyCap": 100
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({keywordId: 101, linkId: 12, channelIds: [], dailyCap: 100})
};

fetch('https://app.octolens.com/api/v2/integrations/discord/monitors', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.octolens.com/api/v2/integrations/discord/monitors",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'keywordId' => 101,
    'linkId' => 12,
    'channelIds' => [
        
    ],
    'dailyCap' => 100
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.octolens.com/api/v2/integrations/discord/monitors"

	payload := strings.NewReader("{\n  \"keywordId\": 101,\n  \"linkId\": 12,\n  \"channelIds\": [],\n  \"dailyCap\": 100\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.octolens.com/api/v2/integrations/discord/monitors")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"keywordId\": 101,\n  \"linkId\": 12,\n  \"channelIds\": [],\n  \"dailyCap\": 100\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.octolens.com/api/v2/integrations/discord/monitors")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"keywordId\": 101,\n  \"linkId\": 12,\n  \"channelIds\": [],\n  \"dailyCap\": 100\n}"

response = http.request(request)
puts response.read_body

{
  "id": 0,
  "linkId": 0,
  "guildId": "1290000000000000200",
  "keywordId": 0,
  "channelIds": [
    "1290000000000000200"
  ],
  "status": "active",
  "dailyCap": 0,
  "todayCount": 0,
  "lastErrorCode": "<string>",
  "estimatedMonthlyMentions": 0,
  "createdAt": "2026-10-28T12:00:00.000Z",
  "updatedAt": "2026-10-28T12:00:00.000Z"
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}