{ "openapi": "3.0.1", "info": { "title": "Change & Alert Engine - Webhook on Change", "description": "Generic change-detection engine: poll any URL, JSON feed or RSS/Atom feed, diff it against the last seen state (key-value store), and push ONLY the changes to the dataset and/or a webhook. Each change carries {item_id, change_type, before, after, changed_at}.", "version": "0.1", "x-build-id": "UFcvlpBxEFBmrhNLL" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/darknezz~change-alert-engine/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-darknezz-change-alert-engine", "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/darknezz~change-alert-engine/runs": { "post": { "operationId": "runs-sync-darknezz-change-alert-engine", "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/darknezz~change-alert-engine/run-sync": { "post": { "operationId": "run-sync-darknezz-change-alert-engine", "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", "properties": { "sourceUrl": { "title": "Source URL", "type": "string", "description": "Any URL to monitor: a JSON feed (array or object), an RSS/Atom feed, or an HTML page (page-level change detection). When empty, the actor polls the Hacker News front page feed by default.", "default": "https://hnrss.org/frontpage" }, "interval": { "title": "Poll interval (informational)", "type": "string", "description": "How often you intend to schedule this actor (e.g. 15m, 1h, 0 9 * * *). Used for the schedule you configure on the actor and included in the webhook payload; the actor itself polls once per run.", "default": "15m" }, "webhook": { "title": "Webhook URL (optional)", "type": "string", "description": "If set, one POST with the full changes payload is sent per run that has at least one change. No request is sent when nothing changed. If the POST fails, the run FAILS and state is NOT persisted, so the next run re-emits the changes (at-least-once delivery).", "default": "" }, "dedupe": { "title": "Dedupe across runs", "type": "boolean", "description": "true (default): persist the last seen state in the key-value store and emit only new/changed/removed items. false: emit the full snapshot on every run without persisting state.", "default": true }, "itemsPath": { "title": "Items path (JSON feeds)", "type": "string", "description": "Dot path to the item list inside a JSON object, e.g. data.items or results. When empty, common keys (items, results, data, records, entries...) are auto-detected; if none found the whole object is treated as one item." }, "idField": { "title": "ID field (JSON feeds)", "type": "string", "description": "Field to use as the stable item id. When empty, common keys (id, guid, itemId, permalink, slug, link, url, title, name) are tried; if none exist the item hash is used (any edit looks like add+remove)." }, "ignoreFields": { "title": "Ignore fields", "type": "string", "description": "Comma-separated top-level fields stripped before hashing (e.g. updatedAt, fetchedAt) so volatile metadata does not produce false modifications." }, "includeRemovals": { "title": "Report removed items", "type": "boolean", "description": "When true, items that were in the last seen state but are missing from the current fetch are emitted as removed changes (after=null). Off by default because items rotating off a feed's first page are often not meaningful.", "default": false }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Maximum number of items to consider from the source on each poll.", "default": 500 } } }, "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 } } } } } } } } } }