# CatchAll - Create Monitor (`newscatcher/catchall-create-monitor`) Actor Create a scheduled monitor for recurring CatchAll jobs with optional webhook delivery. - **URL**: https://apify.com/newscatcher/catchall-create-monitor.md - **Developed by:** [Newscatcher-CatchAll](https://apify.com/newscatcher) (community) - **Categories:** AI, News, Automation - **Stats:** 1 total users, 0 monthly users, 0.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing $0.00/month + usage To use this Actor, you pay a monthly rental fee to the developer. The rent is subtracted from your prepaid usage every month after the free trial period.You also pay for the Apify platform usage, which gets cheaper the higher Apify subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#rental-actors ## 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 ## CatchAll Create Monitor — schedule recurring jobs CatchAll Create Monitor sets up automated, recurring CatchAll jobs based on a completed reference job. The monitor reuses the query, validators, and enrichments from the reference job and runs on your specified schedule. Configure a webhook to receive notifications when each scheduled job completes. This Actor maps to the [`POST /catchAll/monitors/create`](https://www.newscatcherapi.com/docs/web-search-api/api-reference/monitors/create-monitor) endpoint. ### When to use this Actor - **Track ongoing events.** Monitor funding rounds, executive changes, regulatory approvals, or any recurring topic automatically. - **Build data feeds.** Schedule daily or weekly jobs and push results to external services using webhooks. - **Avoid manual reruns.** Set up a monitor once and let it run on schedule, deduplicating records across executions at the API level. ### Input | Field | Type | Required | Description | |-------|------|----------|-------------| | `apiKey` | String | Yes | Your CatchAll API key | | `referenceJobId` | String | Yes | Job ID of a successfully completed job to use as template | | `schedule` | String | Yes | Schedule in plain text (e.g., `"every day at 12 PM UTC"`) | | `webhookUrl` | String | Yes | URL to receive notifications when jobs complete | | `webhookMethod` | String | No | HTTP method for webhook: `POST`, `PUT`, or `PATCH` (default: `POST`) | | `webhookAuthHeader` | String | No | Authorization header value (e.g., `"Bearer YOUR_TOKEN"`) | | `webhookHeaders` | Object | No | Additional HTTP headers as a JSON object | #### Input example ```json { "apiKey": "YOUR_CATCHALL_API_KEY", "referenceJobId": "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c", "schedule": "every day at 12 PM UTC", "webhookUrl": "https://your-endpoint.com/webhook", "webhookAuthHeader": "Bearer YOUR_TOKEN" } ```` The schedule is specified in plain text and converted to a cron expression by the API. Examples: `"every day at 9 AM UTC"`, `"every Monday at 8 AM UTC"`, `"every 6 hours"`. ### Output The Actor returns the `monitor_id` in the default Dataset. Use this ID with other monitor Actors to manage, update, or retrieve results. #### Output example ```json { "monitor_id": "3fec5b07-8786-46d7-9486-d43ff67eccd4", "status": "Monitor Created Successfully" } ``` ### Monitor vs. Apify schedules CatchAll monitors and Apify schedules both run jobs on a recurring basis, but they serve different purposes: - **CatchAll monitors** handle job scheduling and record deduplication at the API level. Results from all executions are aggregated and accessible via the CatchAll API. - **Apify schedules** run any Actor on a schedule from the Apify Console. Use these when you want platform-level control or need to chain other Actors after each run. You can use either approach, or combine them. ### Other CatchAll Actors | Actor | Description | |-------|-------------| | [CatchAll](https://apify.com/newscatcher/catchall) | End-to-end job: submit, poll, and retrieve results | | [CatchAll Update Monitor](https://apify.com/newscatcher/catchall-update-monitor) | Update a monitor's webhook configuration | | [CatchAll Start/Stop Monitor](https://apify.com/newscatcher/catchall-start-stop-monitor) | Pause or resume a monitor | For the full list, visit the [Newscatcher](https://apify.com/newscatcher) organization page. ### Resources - [CatchAll documentation](https://www.newscatcherapi.com/docs/web-search-api/get-started/introduction) - [Monitors guide](https://www.newscatcherapi.com/docs/web-search-api/guides-and-concepts/monitors) # Actor input Schema ## `apiKey` (type: `string`): Your CatchAll API key ## `referenceJobId` (type: `string`): Existing job\_id that the monitor will reference ## `schedule` (type: `string`): Example: "every day at 12 PM UTC" ## `webhookUrl` (type: `string`): Your webhook endpoint URL ## `webhookMethod` (type: `string`): HTTP method, usually POST ## `webhookAuthHeader` (type: `string`): Example: "Bearer YOUR\_TOKEN" ## `webhookHeaders` (type: `object`): Additional headers as JSON object (string values only) ## Actor input object example ```json { "webhookMethod": "POST", "webhookHeaders": {} } ``` # 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 = { "webhookHeaders": {} }; // Run the Actor and wait for it to finish const run = await client.actor("newscatcher/catchall-create-monitor").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 = { "webhookHeaders": {} } # Run the Actor and wait for it to finish run = client.actor("newscatcher/catchall-create-monitor").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 '{ "webhookHeaders": {} }' | apify call newscatcher/catchall-create-monitor --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=newscatcher/catchall-create-monitor", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "CatchAll - Create Monitor", "description": "Create a scheduled monitor for recurring CatchAll jobs with optional webhook delivery.", "version": "0.0", "x-build-id": "3D4zQBVmzhRCpI5I8" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/newscatcher~catchall-create-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-newscatcher-catchall-create-monitor", "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/newscatcher~catchall-create-monitor/runs": { "post": { "operationId": "runs-sync-newscatcher-catchall-create-monitor", "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/newscatcher~catchall-create-monitor/run-sync": { "post": { "operationId": "run-sync-newscatcher-catchall-create-monitor", "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": [ "apiKey", "referenceJobId", "schedule", "webhookUrl" ], "properties": { "apiKey": { "title": "CatchAll API Key", "type": "string", "description": "Your CatchAll API key" }, "referenceJobId": { "title": "Reference Job ID", "type": "string", "description": "Existing job_id that the monitor will reference" }, "schedule": { "title": "Schedule", "type": "string", "description": "Example: \"every day at 12 PM UTC\"" }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "Your webhook endpoint URL" }, "webhookMethod": { "title": "Webhook Method", "enum": [ "POST", "PUT", "PATCH" ], "type": "string", "description": "HTTP method, usually POST", "default": "POST" }, "webhookAuthHeader": { "title": "Authorization header value (optional)", "type": "string", "description": "Example: \"Bearer YOUR_TOKEN\"" }, "webhookHeaders": { "title": "Extra webhook headers (optional)", "type": "object", "description": "Additional headers as JSON object (string values only)" } } }, "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 } } } } } } } } } } ```