# Tweet Catcher

> Monitor X and Truth Social accounts and deliver events to Discord, Telegram, webhooks, or WebSocket

- [Introduction](https://docs.tweet-catcher.com/index.md): What Tweet Catcher Cloud Monitor does and where to start
- [Quickstart](https://docs.tweet-catcher.com/quickstart.md): Sign in, create a Twitter task, and receive the first notification
- [Plans](https://docs.tweet-catcher.com/plans.md): Compare Base and Pro, and add extra task slots or Twitter Global keyword monitoring
- [Tasks](https://docs.tweet-catcher.com/monitor/tasks.md): Find, start, stop, edit, and delete your monitor tasks
- [Create a task](https://docs.tweet-catcher.com/monitor/create-task.md): Set up a task to monitor an account or keyword, choose which events to watch, and where notifications go
- [Notifications](https://docs.tweet-catcher.com/monitor/notifications.md): Send task events to Discord, Telegram, a custom webhook, or the WebSocket
- [Settings](https://docs.tweet-catcher.com/monitor/settings.md): Configure the notification sound, Discord and Telegram defaults, Pro options, and your API key
- [Teams](https://docs.tweet-catcher.com/monitor/teams.md): Invite up to five people to manage your tasks on the Pro plan
- [Discord bot](https://docs.tweet-catcher.com/monitor/discord-bot.md): Create, start, and stop tasks from your Discord server with slash or text commands
- [Pro plan](https://docs.tweet-catcher.com/pro/overview.md): What Pro adds on top of a Base membership
- [WebSocket](https://docs.tweet-catcher.com/pro/websocket.md): Stream task events to your code over a persistent connection
- [Events](https://docs.tweet-catcher.com/pro/events.md): JSON shapes pushed over WebSocket and posted to custom webhooks
- [API](https://docs.tweet-catcher.com/pro/api.md): Create, edit, start, and stop monitoring tasks from your own code with the Pro REST API
- [Get User Info](https://docs.tweet-catcher.com/pro/api/manage-tasks/get-user-info.md): Returns a snapshot of the authenticated account, including:
- [Get Tasks List](https://docs.tweet-catcher.com/pro/api/manage-tasks/get-tasks-list.md): Returns all tasks belonging to the authenticated account
- [Add Task](https://docs.tweet-catcher.com/pro/api/manage-tasks/add-task.md): Creates a new monitoring task for the authenticated account
- [Start Task](https://docs.tweet-catcher.com/pro/api/manage-tasks/start-task.md): Activates a previously created (or stopped) task by its ID
- [Edit Task](https://docs.tweet-catcher.com/pro/api/manage-tasks/edit-task.md): Updates the configuration of an existing task
- [Stop Task](https://docs.tweet-catcher.com/pro/api/manage-tasks/stop-task.md): Pauses a running task without deleting it
- [Delete Task](https://docs.tweet-catcher.com/pro/api/manage-tasks/delete-task.md): Permanently delete a task
- [Bulk Add Tasks](https://docs.tweet-catcher.com/pro/api/manage-tasks/bulk-add-tasks.md): Creates up to 200 tasks in a single request. Progress is streamed back via **Server-Sent Events** — one `progress` event per task, followed by `done` (or `error` on a fatal failure)
- [Bulk Start Tasks](https://docs.tweet-catcher.com/pro/api/manage-tasks/bulk-start-tasks.md): Starts up to 200 tasks by ID. Progress is streamed back via **Server-Sent Events** — one `progress` event per task, followed by `done` (or `error` on a fatal failure)
- [Bulk Edit Tasks](https://docs.tweet-catcher.com/pro/api/manage-tasks/bulk-edit-tasks.md): Edits up to 200 tasks in a single request. Progress is streamed back via **Server-Sent Events** — one `progress` event per task, followed by `done` (or `error` on a fatal failure)
- [Bulk Stop Tasks](https://docs.tweet-catcher.com/pro/api/manage-tasks/bulk-stop-tasks.md): Stops up to 200 tasks by ID. Progress is streamed back via **Server-Sent Events** — one `progress` event per task, followed by `done` (or `error` on a fatal failure)
- [Bulk Delete Tasks](https://docs.tweet-catcher.com/pro/api/manage-tasks/bulk-delete-tasks.md): Deletes up to 200 tasks by ID. Progress is streamed back via **Server-Sent Events** — one `progress` event per task, followed by `done` (or `error` on a fatal failure)
- [Get Username History](https://docs.tweet-catcher.com/pro/api/user-data/get-username-history.md): Returns the known previous usernames of a Twitter/X profile, ordered from most recent to oldest
- [Terms of service](https://docs.tweet-catcher.com/legal/terms.md): Terms for the Tweet Catcher monitoring service
- [Privacy policy](https://docs.tweet-catcher.com/legal/privacy.md): What Tweet Catcher collects and how it is used

## OpenAPI Specs

- [api-specification](/api-specification.yaml)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.