# GitHub Issue Notifier (`jkuzz/github-issue-notifier`) Actor - **URL**: https://apify.com/jkuzz/github-issue-notifier.md - **Developed by:** [Jan KuΕΎelΓ­k](https://apify.com/jkuzz) (community) - **Categories:** Developer tools, Automation, Open source - **Stats:** 3 total users, 0 monthly users, 100.0% runs succeeded, 2 bookmarks - **User rating**: No ratings yet ## Pricing Pay per usage This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-usage ## 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 Github Issue Notifier is built to **watch the selected GitHub repositories for new issues containing at least one of the selected keywords**. The discovered issues are output into the default dataset and, if configured, sent as Slack messages. Finds all existing issues on first run and only new ones since the last search on subsequent runs. Issue edits are not accounted for. ### Input To run this Actor, you'll need at least one Github repository and a Slack API token. You can get the token by following the instructions on the [Slack tutorials page](https://api.slack.com/tutorials/tracks/getting-a-token). Here's the full input that you'll need: - URLs or repository names of repositories you want to monitor. - Keywords that will be looked for in the titles and bodies of new issues. Thje search is not case-sensitive. - Slack channel where the notification with Github issues information will be sent (e.g. #notifications). - Slack API token in a format xoxp-xxxxxxxxx-xxxx. ### Output Each run of this Actor outputs an array of new issues. The issue objects are what GitHub's Octokit API returns, see more at [their docs](https://docs.github.com/en/rest/issues/issues?apiVersion=2022-11-28#list-repository-issues). ### How to run Github Issue Notifier 1. Get a free Apify account. 2. Create a new task. 3. Modify the Actor input configuration as needed: add GitHub repository names, keywords, Slack API token and channel. 4. Click the Start button. 5. Get your notified in the respective channel whenever an event in GitHub repository occurs. ### Want to automate Slack notifications or track GitHub issues? You can use the simple automation tools below. Some of them are built for relevant Slack notification case that you can set up for GitHub, Toggl, or other platforms. Some of them are built specifically for GitHub. Feel free to browse them:
πŸ’Œ Slack Message Generator πŸ‘€ Slack Messages Downloader
⚠️ Github Issues Tracker πŸ… Github Champion Scraper
# Actor input Schema ## `searchRepos` (type: `array`): The URLs or repository names of repositories you want to monitor. ## `searchKeywords` (type: `array`): The keywords that will be looked for in the titles and bodies of new issues. ## `slackToken` (type: `string`): Slack API token in a format xoxp-xxxxxxxxx-xxxx. ## `slackChannel` (type: `string`): Channel where the notification with Github issues information will be sent (e.g. #general) ## Actor input object example ```json { "searchRepos": [], "searchKeywords": [], "slackChannel": "#general" } ```` # 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 = { "searchRepos": [], "searchKeywords": [], "slackChannel": "#general" }; // Run the Actor and wait for it to finish const run = await client.actor("jkuzz/github-issue-notifier").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 = { "searchRepos": [], "searchKeywords": [], "slackChannel": "#general", } # Run the Actor and wait for it to finish run = client.actor("jkuzz/github-issue-notifier").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 '{ "searchRepos": [], "searchKeywords": [], "slackChannel": "#general" }' | apify call jkuzz/github-issue-notifier --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=jkuzz/github-issue-notifier", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "GitHub Issue Notifier", "description": null, "version": "0.0", "x-build-id": "Y3TN8SyFlTj01Ra9G" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jkuzz~github-issue-notifier/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jkuzz-github-issue-notifier", "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/jkuzz~github-issue-notifier/runs": { "post": { "operationId": "runs-sync-jkuzz-github-issue-notifier", "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/jkuzz~github-issue-notifier/run-sync": { "post": { "operationId": "run-sync-jkuzz-github-issue-notifier", "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": [ "searchRepos", "searchKeywords" ], "properties": { "searchRepos": { "title": "URL or names of repositories", "type": "array", "description": "The URLs or repository names of repositories you want to monitor.", "items": { "type": "string" } }, "searchKeywords": { "title": "Keywords to search for", "type": "array", "description": "The keywords that will be looked for in the titles and bodies of new issues.", "items": { "type": "string" } }, "slackToken": { "title": "Slack token", "type": "string", "description": "Slack API token in a format xoxp-xxxxxxxxx-xxxx." }, "slackChannel": { "title": "Slack channel", "type": "string", "description": "Channel where the notification with Github issues information will be sent (e.g. #general)" } } }, "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 } } } } } } } } } } ```