# Rocket.Chat Message Scraper (`jungle_synthesizer/rocketchat-message-scraper`) Actor Export messages, channels, private groups, and direct messages from any Rocket.Chat instance using the REST API. Authenticate with a personal access token. Supports date-range filters, room allowlists, and full thread history. - **URL**: https://apify.com/jungle\_synthesizer/rocketchat-message-scraper.md - **Developed by:** [BowTiedRaccoon](https://apify.com/jungle_synthesizer) (community) - **Categories:** Social media, Business - **Stats:** 1 total users, 0 monthly users, 0.0% runs succeeded, NaN bookmarks - **User rating**: No ratings yet ## Pricing Pay per event This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## Rocket.Chat Message Scraper Export messages, channels, private groups, and direct messages from any Rocket.Chat instance using the official REST API. ### What it does Connect to any self-hosted or cloud Rocket.Chat instance and download your message history. Authenticate with a personal access token and choose which room types to export: public channels, private groups, or direct messages. Optionally filter by date range or specific room IDs. Works with Rocket.Chat Community Edition, Enterprise Edition, and cloud-hosted workspaces. ### Use cases - **Compliance archival** — Export message history for legal or regulatory retention - **Migration** — Move message data to a new platform or data warehouse - **Knowledge base extraction** — Mine conversations for documentation and institutional knowledge - **Analytics** — Analyze communication patterns, response times, and topic trends - **Backup** — Create offline snapshots of workspace history ### Setup: generating your personal access token 1. Log in to your Rocket.Chat instance 2. Click your avatar in the top-left corner then **Profile** 3. Scroll down to **Personal Access Tokens** 4. Click **Add** and give the token a name (e.g. `orbtop-export`) 5. If prompted, enter your password and enable 2FA if required 6. Copy both the **Token** and your **User ID** (shown above the token list) These two values go into the **Auth Token** and **User ID** input fields. ### Input parameters | Parameter | Description | Default | |-----------|-------------|---------| | Instance URL | Base URL of your Rocket.Chat instance | `https://open.rocket.chat` | | User ID | Your Rocket.Chat User ID | Required | | Auth Token | Personal access token | Required | | Room IDs | Limit to specific rooms (optional) | All accessible rooms | | Room Types | Types to scrape: `c` (channels), `p` (private groups), `d` (direct messages) | All types | | Date From | Only fetch messages on or after this date (ISO format) | No filter | | Date To | Only fetch messages on or before this date (ISO format) | No filter | | Include Thread Replies | Fetch replies nested in threads | `false` | | Max Items | Maximum records to save (0 = unlimited) | No limit | ### Output format Each exported message is saved as one dataset record: | Field | Description | |-------|-------------| | `instance_url` | The Rocket.Chat instance base URL | | `room_id` | Rocket.Chat room identifier | | `room_name` | Human-readable room name | | `room_type` | `c` (channel), `p` (private group), `d` (direct message) | | `room_topic` | Room topic string | | `room_description` | Room description string | | `message_id` | Unique message identifier | | `message_rid` | Room ID the message belongs to | | `message_ts` | Message creation timestamp (ISO 8601) | | `message_update_at` | Last edit timestamp (ISO 8601) | | `message_user_id` | Sender User ID | | `message_user_username` | Sender username | | `message_user_name` | Sender display name | | `message_msg` | Plain-text message body | | `message_type` | Message type (empty = normal, `rm` = deleted, `uj` = join, etc.) | | `message_thread_msg_id` | Parent message ID if this is a thread reply | | `message_attachments` | JSON array of file/image attachments | | `message_reactions` | JSON map of emoji reactions and users | | `message_urls` | JSON array of embedded URLs | | `message_mentions` | JSON array of @mentions | | `message_channels` | JSON array of #channel references | ### Pricing Pay-per-result. The actor charges a small start fee plus a per-record fee for each message saved. No charge for error records. ### Notes - The scraper pages through the Rocket.Chat API (100 messages per request). Large workspaces may take time depending on instance rate limits. - Authentication failures produce an error record in the dataset and exit cleanly. Check the `status` field — `AUTH_ERROR` means the token is invalid or expired; `INPUT_ERROR` means a required field is missing. - Thread replies require an extra API call per thread and are disabled by default. Enable with `includeThreadReplies: true`. - The API only returns rooms and messages visible to the authenticated user. Admin accounts can access more rooms. - Private groups and direct messages require the account to be a member of the room. # Actor input Schema ## `sp_intended_usage` (type: `string`): Please describe how you plan to use the data extracted by this crawler. ## `sp_improvement_suggestions` (type: `string`): Provide any feedback or suggestions for improvements. ## `sp_contact` (type: `string`): Provide your email address so we can get in touch with you. ## `instanceUrl` (type: `string`): Base URL of your Rocket.Chat instance, e.g. https://chat.example.com ## `userId` (type: `string`): Your Rocket.Chat User ID (found in Account → Profile → Personal Access Tokens). ## `authToken` (type: `string`): Personal Access Token generated in Account → Profile → Personal Access Tokens. Ignored if token is set. ## `roomIds` (type: `array`): Limit scraping to specific room IDs. Leave empty to scrape all accessible rooms. Accepts channel IDs, group IDs, or DM IDs. ## `roomTypes` (type: `array`): Room types to include: c (public channels), p (private groups), d (direct messages). Default scrapes all types. ## `dateFrom` (type: `string`): Fetch messages on or after this ISO date (YYYY-MM-DD or full ISO timestamp). Leave empty for all messages. ## `dateTo` (type: `string`): Fetch messages on or before this ISO date (YYYY-MM-DD or full ISO timestamp). Leave empty for all messages. ## `includeThreadReplies` (type: `boolean`): Fetch replies within message threads (adds extra API calls). ## `maxItems` (type: `integer`): Maximum number of message records to save (0 = unlimited). ## Actor input object example ```json { "sp_intended_usage": "Describe your intended use...", "sp_improvement_suggestions": "Share your suggestions here...", "sp_contact": "Share your email here...", "instanceUrl": "https://open.rocket.chat", "roomIds": [ "" ], "roomTypes": [ "c", "p", "d" ], "includeThreadReplies": false, "maxItems": 10 } ```` # Actor output Schema ## `results` (type: `string`): No description # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "sp_intended_usage": "Describe your intended use...", "sp_improvement_suggestions": "Share your suggestions here...", "sp_contact": "Share your email here...", "instanceUrl": "https://open.rocket.chat", "userId": "", "authToken": "", "roomIds": [ "" ], "roomTypes": [ "c", "p", "d" ], "dateFrom": "", "dateTo": "", "includeThreadReplies": false, "maxItems": 10 }; // Run the Actor and wait for it to finish const run = await client.actor("jungle_synthesizer/rocketchat-message-scraper").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "sp_intended_usage": "Describe your intended use...", "sp_improvement_suggestions": "Share your suggestions here...", "sp_contact": "Share your email here...", "instanceUrl": "https://open.rocket.chat", "userId": "", "authToken": "", "roomIds": [""], "roomTypes": [ "c", "p", "d", ], "dateFrom": "", "dateTo": "", "includeThreadReplies": False, "maxItems": 10, } # Run the Actor and wait for it to finish run = client.actor("jungle_synthesizer/rocketchat-message-scraper").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "sp_intended_usage": "Describe your intended use...", "sp_improvement_suggestions": "Share your suggestions here...", "sp_contact": "Share your email here...", "instanceUrl": "https://open.rocket.chat", "userId": "", "authToken": "", "roomIds": [ "" ], "roomTypes": [ "c", "p", "d" ], "dateFrom": "", "dateTo": "", "includeThreadReplies": false, "maxItems": 10 }' | apify call jungle_synthesizer/rocketchat-message-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=jungle_synthesizer/rocketchat-message-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Rocket.Chat Message Scraper", "description": "Export messages, channels, private groups, and direct messages from any Rocket.Chat instance using the REST API. Authenticate with a personal access token. Supports date-range filters, room allowlists, and full thread history.", "version": "0.1", "x-build-id": "Rm0Ty6769G1peoDZF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jungle_synthesizer~rocketchat-message-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jungle_synthesizer-rocketchat-message-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/jungle_synthesizer~rocketchat-message-scraper/runs": { "post": { "operationId": "runs-sync-jungle_synthesizer-rocketchat-message-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/jungle_synthesizer~rocketchat-message-scraper/run-sync": { "post": { "operationId": "run-sync-jungle_synthesizer-rocketchat-message-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "instanceUrl", "userId", "authToken", "roomTypes" ], "properties": { "sp_intended_usage": { "title": "What is the intended usage of this data?", "minLength": 1, "type": "string", "description": "Please describe how you plan to use the data extracted by this crawler." }, "sp_improvement_suggestions": { "title": "How can we improve this crawler for you?", "minLength": 1, "type": "string", "description": "Provide any feedback or suggestions for improvements." }, "sp_contact": { "title": "Contact Email", "minLength": 1, "type": "string", "description": "Provide your email address so we can get in touch with you." }, "instanceUrl": { "title": "Instance URL", "type": "string", "description": "Base URL of your Rocket.Chat instance, e.g. https://chat.example.com" }, "userId": { "title": "User ID", "type": "string", "description": "Your Rocket.Chat User ID (found in Account → Profile → Personal Access Tokens)." }, "authToken": { "title": "Auth Token", "type": "string", "description": "Personal Access Token generated in Account → Profile → Personal Access Tokens. Ignored if token is set." }, "roomIds": { "title": "Room IDs (optional)", "type": "array", "description": "Limit scraping to specific room IDs. Leave empty to scrape all accessible rooms. Accepts channel IDs, group IDs, or DM IDs.", "items": { "type": "string" } }, "roomTypes": { "title": "Room Types", "type": "array", "description": "Room types to include: c (public channels), p (private groups), d (direct messages). Default scrapes all types.", "items": { "type": "string" } }, "dateFrom": { "title": "Date From (optional)", "type": "string", "description": "Fetch messages on or after this ISO date (YYYY-MM-DD or full ISO timestamp). Leave empty for all messages." }, "dateTo": { "title": "Date To (optional)", "type": "string", "description": "Fetch messages on or before this ISO date (YYYY-MM-DD or full ISO timestamp). Leave empty for all messages." }, "includeThreadReplies": { "title": "Include Thread Replies", "type": "boolean", "description": "Fetch replies within message threads (adds extra API calls).", "default": false }, "maxItems": { "title": "Max Items", "type": "integer", "description": "Maximum number of message records to save (0 = unlimited)." } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } } ```