{ "openapi": "3.0.1", "info": { "title": "ProjectDiscovery Notify", "description": "Stream text or dataset records to Slack, Discord, Telegram, Email and other platforms using the ProjectDiscovery notify CLI.", "version": "1.0", "x-build-id": "RIJaQfXElDCTUcBrg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/rl1987~pd-notify/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-rl1987-pd-notify", "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/rl1987~pd-notify/runs": { "post": { "operationId": "runs-sync-rl1987-pd-notify", "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/rl1987~pd-notify/run-sync": { "post": { "operationId": "run-sync-rl1987-pd-notify", "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": { "data": { "title": "Text to send", "type": "string", "description": "Raw text to send as a notification. Each line becomes a separate notification unless bulk mode is enabled. Leave empty if you read input from a source dataset instead." }, "sourceDatasetId": { "title": "Source dataset ID", "type": "string", "description": "ID of an Apify dataset to read input from (e.g. the output of a previous Actor in your pipeline). Each item is turned into one line of notification text. Combined with the `Text to send` field if both are provided." }, "datasetFields": { "title": "Dataset fields", "type": "array", "description": "Which fields to extract from each source dataset item. When empty, the whole item is serialized to compact JSON. Multiple fields are joined with the field separator.", "default": [], "items": { "type": "string" } }, "datasetFieldSeparator": { "title": "Dataset field separator", "type": "string", "description": "String used to join multiple dataset fields into a single line.", "default": " | " }, "slackWebhookUrl": { "title": "Slack webhook URL", "type": "string", "description": "Incoming webhook URL for a Slack channel. When set, a Slack provider (id `slack`) is added automatically." }, "slackChannel": { "title": "Slack channel", "type": "string", "description": "Optional channel name to post to (e.g. recon). Only used when a Slack webhook URL is set." }, "discordWebhookUrl": { "title": "Discord webhook URL", "type": "string", "description": "Webhook URL for a Discord channel. When set, a Discord provider (id `discord`) is added automatically." }, "telegramApiKey": { "title": "Telegram bot API key", "type": "string", "description": "Telegram bot token. When set together with a chat ID, a Telegram provider (id `telegram`) is added automatically." }, "telegramChatId": { "title": "Telegram chat ID", "type": "string", "description": "Telegram chat ID to send messages to. Required when a Telegram bot API key is set." }, "providerConfigYaml": { "title": "Advanced provider config (YAML)", "type": "string", "description": "Contents of the notify provider-config.yaml, defining any provider(s), webhooks and credentials. Merged with the quick-setup fields above. See https://github.com/projectdiscovery/notify#provider-config for the format. Treated as a secret." }, "providers": { "title": "Providers", "type": "array", "description": "Restrict sending to these provider types only (e.g. slack, discord, telegram). Maps to the notify `-provider` flag. Empty = all providers in the config.", "default": [], "items": { "type": "string" } }, "ids": { "title": "Provider IDs", "type": "array", "description": "Restrict sending to provider entries with these `id` values (e.g. recon, vulns). Maps to the notify `-id` flag. Empty = all IDs.", "default": [], "items": { "type": "string" } }, "bulk": { "title": "Bulk mode", "type": "boolean", "description": "Send the whole input as one (chunked) message instead of one notification per line. Maps to the notify `-bulk` flag.", "default": false }, "charLimit": { "title": "Character limit", "minimum": 1, "type": "integer", "description": "Maximum number of characters per message. Maps to the notify `-char-limit` flag.", "default": 4000 }, "delay": { "title": "Delay (seconds)", "minimum": 0, "type": "integer", "description": "Delay in seconds between each notification. Maps to the notify `-delay` flag.", "default": 0 }, "rateLimit": { "title": "Rate limit (req/s)", "minimum": 0, "type": "integer", "description": "Maximum number of HTTP requests to send per second. Maps to the notify `-rate-limit` flag. 0 = use notify default.", "default": 0 }, "msgFormat": { "title": "Message format", "type": "string", "description": "Custom message formatting template. Use {{data}} as the placeholder for the line content, e.g. `Alert: {{data}}`. Maps to the notify `-msg-format` flag." }, "proxy": { "title": "Proxy", "type": "string", "description": "HTTP/SOCKSv5 proxy to route notifications through, e.g. http://127.0.0.1:8080. Maps to the notify `-proxy` flag." }, "verbose": { "title": "Verbose output", "type": "boolean", "description": "Enable verbose logging from notify. Maps to the notify `-verbose` flag.", "default": false } } }, "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 } } } } } } } } } }