{"id":21611269,"url":"https://github.com/runnerty/notifier-telegram","last_synced_at":"2025-03-18T16:04:34.684Z","repository":{"id":28668819,"uuid":"119021603","full_name":"runnerty/notifier-telegram","owner":"runnerty","description":"Runnerty module: Telegram notifier.","archived":false,"fork":false,"pushed_at":"2023-09-07T06:12:31.000Z","size":195,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-02-26T03:08:34.808Z","etag":null,"topics":["notifier","runnerty","telegram"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/runnerty.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-01-26T07:43:03.000Z","updated_at":"2022-02-05T18:28:25.000Z","dependencies_parsed_at":"2024-11-24T21:11:53.984Z","dependency_job_id":"c1405179-2fbb-4228-b8bc-5b9d4870d1aa","html_url":"https://github.com/runnerty/notifier-telegram","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/runnerty%2Fnotifier-telegram","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/runnerty%2Fnotifier-telegram/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/runnerty%2Fnotifier-telegram/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/runnerty%2Fnotifier-telegram/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/runnerty","download_url":"https://codeload.github.com/runnerty/notifier-telegram/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244257278,"owners_count":20424130,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["notifier","runnerty","telegram"],"created_at":"2024-11-24T21:11:46.897Z","updated_at":"2025-03-18T16:04:34.658Z","avatar_url":"https://github.com/runnerty.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"http://runnerty.io\"\u003e\n    \u003cimg height=\"257\" src=\"https://runnerty.io/assets/header/logo-stroked.png\"\u003e\n  \u003c/a\u003e\n  \u003cp align=\"center\"\u003eSmart Processes Management\u003c/p\u003e\n\u003c/p\u003e\n\n[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url]\n\u003ca href=\"#badge\"\u003e\n\u003cimg alt=\"code style: prettier\" src=\"https://img.shields.io/badge/code_style-prettier-ff69b4.svg\"\u003e\n\u003c/a\u003e\n\n# Telegram notifier for [Runnerty]:\n\n### Installation:\n\nThrough NPM\n\n```bash\nnpm i @runnerty/notifier-telegram\n```\n\nYou can also add modules to your project with [runnerty]\n\n```bash\nnpx runnerty add @runnerty/notifier-telegram\n```\n\nThis command installs the module in your project, adds example configuration in your [config.json] and creates an example plan of use.\n\nIf you have installed [runnerty] globally you can include the module with this command:\n\n```bash\nrunnerty add @runnerty/notifier-telegram\n```\n\n### Configuration sample:\n\nAdd it in the notification section of the [config.json] file. More information [here](https://docs.runnerty.io/notifiers):\n\n```json\n{\n  \"id\": \"telegram_default\",\n  \"type\": \"@runnerty-notifier-telegram\",\n  \"token\": \"ABC123\",\n  \"chat_id\": \"ABC123\"\n}\n```\n\nExample:\n\n```json\n{\n  // ...\n  \"notifiers\": [\n    {\n      \"id\": \"telegram_default\",\n      \"type\": \"@runnerty-notifier-telegram\",\n      \"token\": \"MyTokenId\",\n      \"chat_id\": \"MyChatId\"\n    }\n    //...\n  ]\n}\n```\n\n### Plan sample:\n\nAdd add it to any [chain](https://docs.runnerty.io/chain) or [process](https://docs.runnerty.io/process) notification event. More information [here](https://docs.runnerty.io/notifiers):\n\n```json\n{\n  \"id\": \"telegram_default\",\n  \"message\": \"Process @GV(PROCESS_ID) Running!\"\n}\n```\n\nExamples:\n\n```json\n{\n  \"id\": \"PROCESS_SAMPLE\",\n  \"name\": \"Sample process\",\n  \"exec\": {\n    \"id\": \"shell_default\",\n    \"command\": \"echo 'Hello world'\"\n  },\n  \"notifications\": {\n    \"on_end\": [\n      {\n        \"id\": \"telegram_default\",\n        \"message\": \"THE PROCESS @GV(PROCESS_ID) HAS FINISHED\"\n      }\n    ]\n  }\n}\n```\n\n- Video:\n\n```json\n{\n  \"id\": \"PROCESS_SAMPLE\",\n  \"name\": \"Sample process\",\n  \"exec\": {\n    \"id\": \"shell_default\",\n    \"command\": \"echo 'Hello world'\"\n  },\n  \"notifications\": {\n    \"on_end\": [\n      {\n        \"id\": \"telegram_default\",\n        \"message\": \"THE PROCESS @GV(PROCESS_ID) HAS FINISHED\",\n        \"video\": \"./my_video.mp4\"\n      }\n    ]\n  }\n}\n```\n\n[runnerty]: https://www.runnerty.io\n[downloads-image]: https://img.shields.io/npm/dm/@runnerty/notifier-telegram.svg\n[npm-url]: https://www.npmjs.com/package/@runnerty/notifier-telegram\n[npm-image]: https://img.shields.io/npm/v/@runnerty/notifier-telegram.svg\n[david-badge]: https://david-dm.org/runnerty/notifier-telegram.svg\n[david-badge-url]: https://david-dm.org/runnerty/notifier-telegram\n[config.json]: https://docs.runnerty.io/config/\n[notifiers]: https://docs.runnerty.io/notifiers\n[plan.json]: https://docs.runnerty.io/plan/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frunnerty%2Fnotifier-telegram","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frunnerty%2Fnotifier-telegram","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frunnerty%2Fnotifier-telegram/lists"}