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.
| name required | string |
| project_name required | string |
| type required | string Enum: "telegram" "discord" "reddit" "x" "crisp" |
| bot_token | string or null Optional bot token for custom branding |
| whitelisted_external_role_ids | Array of strings Optional list of external role IDs allowed to bypass moderation, only supported for Discord communities |
| 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 |
{- "name": "Dogecoin Dealers Group",
- "project_name": "Dogecoin",
- "type": "telegram"
}{- "code": "ok",
- "message": null,
- "data": {
- "id": "65a57474-1635-4659-a74a-0e1d07564e48"
}
}| id required | string Example: 2910799f-2cd4-4bac-8018-5757bb12e9f0 |
| name required | string |
| type required | string Enum: "telegram" "discord" "reddit" "x" "crisp" |
| status | string Enum: "enabled" "disabled" "deactivated" Optional status for the community. Default if not supplied - enabled. Disabled - mods/admins can re-enable this community by using /watchdog_enable in chat. Deactivated - only reversible by support or this API, effectively treated as deleted |
| bot_token | string or null Optional bot token for custom branding |
| whitelisted_external_role_ids | Array of strings Optional list of external role IDs allowed to bypass moderation, only supported for Discord communities |
| 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 |
{- "name": "Bitcoin Ballers Group",
- "type": "telegram",
- "bot_token": "79420012345:AAHxb...<rest>",
- "whitelisted_external_role_ids": [
- "SomeExternalRoleID1",
- "SomeExternalRoleID2"
], - "whitelisted_usernames": [
- "SatoshiNakamoto",
- "DonaldTrump",
- "BillGates"
], - "should_send_welcome_messages": true,
- "welcome_message": "Welcome to Bitcoin Ballers ${new_member_usernames}! We're glad you're here 🎉",
- "should_process_messages_from_admins": true,
- "alert_channel_message_template": "**Alert:** ${author_username} may have violated a rule."
}{- "code": "ok",
- "message": null,
- "data": null
}| community_id required | string Example: 2910799f-2cd4-4bac-8018-5757bb12e9f0 |
{- "code": "ok",
- "message": "Successfully retrieved community details.",
- "data": {
- "id": "70aea7dd-cf8b-4109-b5e0-50b2a5441f4c",
- "type": "telegram",
- "name": "Some Test Community",
- "external_id": null,
- "status": "enabled",
- "should_answer_questions": false,
- "should_send_welcome_messages": false,
- "should_delete_join_messages": false,
- "whitelisted_usernames": [ ],
- "whitelisted_external_role_ids": [ ],
- "welcome_message": null,
- "should_process_messages_from_admins": false,
- "alert_channel_message_template": null
}
}| community_id required | string Example: 2910799f-2cd4-4bac-8018-5757bb12e9f0 |
| start_date | string <date> Example: start_date=2025-08-28 |
| end_date | string <date> Example: end_date=2025-08-29 |
{- "code": "ok",
- "message": "Successfully retrieved community statistics.",
- "data": {
- "num_messages_analyzed": 5,
- "num_messages_moderated": 1,
- "num_questions_asked": 2,
- "num_questions_answered": 1
}
}