Manage Tasks

Operations for managing Tweet Catcher monitoring tasks

Get User Info

get

Retrieves user account information, including the expiration date, task limits, and current tasks list

Authorizations
Responses
200
User information retrieved successfully
application/json
get
GET /pro/info HTTP/1.1
Host: monitor-api.tweet-catcher.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "expireAt": "2024-12-31T23:59:59Z",
  "tasksLimit": 200,
  "globalMonitorTasksLimit": 5,
  "tasks": [
    {
      "id": 685,
      "module": "twitter",
      "user": "Gioppooo",
      "group": "influencers",
      "options": [
        "ocr",
        "posts",
        "retweets",
        "replies"
      ],
      "notification": "discord",
      "webhook": "https://discord.com/api/webhooks/...",
      "ping": "everyone",
      "running": false
    }
  ]
}

Get Tasks List

get

Retrieves a list of the user's tasks

Authorizations
Query parameters
groupstringOptional

Filter tasks by group

Responses
200
Tasks list retrieved successfully
application/json
get
GET /pro/tasks-list HTTP/1.1
Host: monitor-api.tweet-catcher.com
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": 685,
    "module": "twitter",
    "user": "Gioppooo",
    "group": "influencers",
    "options": [
      "ocr",
      "posts",
      "retweets",
      "replies"
    ],
    "notification": "discord",
    "webhook": "https://discord.com/api/webhooks/...",
    "ping": "everyone",
    "running": false
  },
  {
    "id": 732,
    "module": "twitter",
    "user": "another_user",
    "options": [
      "posts"
    ],
    "notification": "telegram",
    "chatId": "123456789",
    "running": true
  },
  {
    "id": 733,
    "module": "twitter_keyword",
    "keyword": "bitcoin",
    "notification": "websocket",
    "running": true
  }
]

Add Task

post

Adds a new monitoring task

Authorizations
Body
modulestring · enumOptional

Platform module to monitor

Default: twitterPossible values:
userstringOptional

Username to monitor (required unless module is twitter_keyword)

keywordstringOptional

Keyword to monitor (required for twitter_keyword module)

groupstringOptional

Task group for organization

notificationstring · enumRequired

Notification method

Possible values:
webhookstringOptional

Discord webhook URL or custom webhook URL (required for Discord and webhook notifications)

chatIdstringOptional

Telegram chat ID (required for Telegram notifications)

differentWebhooksbooleanOptional

Whether to use different webhooks for different monitoring options

pingstring · enumOptional

Discord ping option

Possible values:
roleIdstringOptional

Discord role ID to ping (required if ping is set to role)

pingKeywordsone ofOptional

Keywords or regex for selective pinging

or
useRegexbooleanOptional

Whether to use regex for ping keywords

startbooleanOptional

Whether to automatically start the task after creation

webhook-postsstringOptional

Webhook for posts (if differentWebhooks is true)

webhook-followingstringOptional

Webhook for following updates (if differentWebhooks is true)

webhook-userUpdatesstringOptional

Webhook for user updates (if differentWebhooks is true)

chatId-postsstringOptional

Telegram chat ID for posts (if differentWebhooks is true)

chatId-followingstringOptional

Telegram chat ID for following updates (if differentWebhooks is true)

chatId-userUpdatesstringOptional

Telegram chat ID for user updates (if differentWebhooks is true)

ignoreImagesbooleanOptional

Whether to ignore images in notifications

Default: false
ignoreVideosbooleanOptional

Whether to ignore videos in notifications

Default: false
Responses
200
Task created successfully
application/json
post
POST /pro/add-task HTTP/1.1
Host: monitor-api.tweet-catcher.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 155

{
  "user": "gioppooo",
  "options": [
    "posts",
    "retweets"
  ],
  "notification": "discord",
  "webhook": "https://discord.com/api/webhooks/...",
  "ping": "everyone",
  "start": true
}
{
  "id": 932
}

Start Task

post

Starts a specific task

Authorizations
Body
idintegerRequired

Task ID

Responses
200
Task started successfully
application/json
post
POST /pro/start-task HTTP/1.1
Host: monitor-api.tweet-catcher.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 10

{
  "id": 932
}
{
  "error": false
}

Edit Task

post

Edits an existing task for the user

Authorizations
Body
idintegerRequired

Task ID to edit

modulestring · enumOptional

Platform module to monitor

Default: twitterPossible values:
userstringOptional

Username to monitor (required unless module is twitter_keyword)

keywordstringOptional

Keyword to monitor (required for twitter_keyword module)

groupstringOptional

Task group for organization

notificationstring · enumOptional

Notification method

Possible values:
webhookstringOptional

Discord webhook URL or custom webhook URL (required for Discord and webhook notifications)

chatIdstringOptional

Telegram chat ID (required for Telegram notifications)

differentWebhooksbooleanOptional

Whether to use different webhooks for different monitoring options

pingstring · enumOptional

Discord ping option

Possible values:
roleIdstringOptional

Discord role ID to ping (required if ping is set to role)

pingKeywordsone ofOptional

Keywords or regex for selective pinging

or
useRegexbooleanOptional

Whether to use regex for ping keywords

startbooleanOptional

Whether to automatically start the task after creation

webhook-postsstringOptional

Webhook for posts (if differentWebhooks is true)

webhook-followingstringOptional

Webhook for following updates (if differentWebhooks is true)

webhook-userUpdatesstringOptional

Webhook for user updates (if differentWebhooks is true)

chatId-postsstringOptional

Telegram chat ID for posts (if differentWebhooks is true)

chatId-followingstringOptional

Telegram chat ID for following updates (if differentWebhooks is true)

chatId-userUpdatesstringOptional

Telegram chat ID for user updates (if differentWebhooks is true)

ignoreImagesbooleanOptional

Whether to ignore images in notifications

Default: false
ignoreVideosbooleanOptional

Whether to ignore videos in notifications

Default: false
Responses
200
Task edited successfully
application/json
post
POST /pro/edit-task HTTP/1.1
Host: monitor-api.tweet-catcher.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 103

{
  "id": 932,
  "module": "twitter",
  "user": "solvingkasada",
  "options": [
    "following"
  ],
  "notification": "websocket"
}
{
  "error": false
}

Stop Task

post

Stops a specific task for the user

Authorizations
Body
idintegerRequired

Task ID

Responses
200
Task stopped successfully
application/json
post
POST /pro/stop-task HTTP/1.1
Host: monitor-api.tweet-catcher.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 10

{
  "id": 932
}
{
  "error": false
}

Delete Task

post

Deletes a specific task for the user

Authorizations
Body
idintegerRequired

Task ID

Responses
200
Task deleted successfully
application/json
post
POST /pro/delete-task HTTP/1.1
Host: monitor-api.tweet-catcher.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 10

{
  "id": 932
}
{
  "error": false
}
PreviousAPINextUser Data