API docs by Redocly

Watchdog Developer API (1.0.0)

Download OpenAPI specification:

APIs for managing communities and fetching statistics in Watchdog. If you need an API key, contact support@watchdog.chat with your use case.

Create a new community

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
required
string
project_name
required
string
external_id
required
string

External community identifier (e.g. Telegram chat ID).

type
required
string
Value: "telegram"
bot_token
string or null

Optional bot token for custom branding

whitelisted_usernames
Array of strings

Optional list of usernames allowed to bypass moderation

should_send_welcome_messages
boolean
welcome_message
string
should_process_messages_from_admins
boolean
alert_channel_message_template
string

Responses

Request samples

Content type
application/json
Example
{
  • "name": "Dogecoin Dealers Group",
  • "project_name": "Dogecoin",
  • "external_id": "-1001234567891",
  • "type": "telegram"
}

Response samples

Content type
application/json
{
  • "code": "ok",
  • "message": null,
  • "data": null
}

Update an existing community

Authorizations:
bearerAuth
path Parameters
id
required
string
Example: 2910799f-2cd4-4bac-8018-5757bb12e9f0
Request Body schema: application/json
required
name
required
string
project_name
required
string
external_id
required
string

External community identifier (e.g. Telegram chat ID).

type
required
string
Value: "telegram"
bot_token
string or null

Optional bot token for custom branding

whitelisted_usernames
Array of strings

Optional list of usernames allowed to bypass moderation

should_send_welcome_messages
boolean
welcome_message
string
should_process_messages_from_admins
boolean
alert_channel_message_template
string

Responses

Request samples

Content type
application/json
{
  • "name": "Bitcoin Ballers Group",
  • "external_id": "-1001234567890",
  • "type": "telegram",
  • "bot_token": "79420012345:AAHxb...<rest>",
  • "whitelisted_usernames": [
    ],
  • "should_send_welcome_messages": true,
  • "welcome_message": "Welcome to Bitcoin Ballers! We're glad you're here 🎉",
  • "should_process_messages_from_admins": true,
  • "alert_channel_message_template": "**Alert:** ${author_username} may have violated a rule."
}

Response samples

Content type
application/json
{
  • "code": "ok",
  • "message": null,
  • "data": null
}

Fetch community statistics

Authorizations:
bearerAuth
path Parameters
community_id
required
string
Example: 2910799f-2cd4-4bac-8018-5757bb12e9f0
query Parameters
start_date
string <date>
Example: start_date=2025-08-28
end_date
string <date>
Example: end_date=2025-08-29

Responses

Response samples

Content type
application/json
{
  • "code": "ok",
  • "message": "Successfully retrieved community statistics.",
  • "data": {
    }
}