https://github.com/runnerty/notifier-telegram

Runnerty module: Telegram notifier.
https://github.com/runnerty/notifier-telegram

notifier runnerty telegram

Last synced: about 1 month ago
JSON representation

Runnerty module: Telegram notifier.

• Host: GitHub
• URL: https://github.com/runnerty/notifier-telegram
• Owner: runnerty
• License: mit
• Created: 2018-01-26T07:43:03.000Z (almost 7 years ago)
• Default Branch: main
• Last Pushed: 2023-09-07T06:12:31.000Z (over 1 year ago)
• Last Synced: 2024-11-14T18:52:18.105Z (about 2 months ago)
• Topics: notifier, runnerty, telegram
• Language: JavaScript
• Size: 190 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

    

  

  
Smart Processes Management


[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url]







# Telegram notifier for [Runnerty]:

### Installation:

Through NPM

```bash

npm i @runnerty/notifier-telegram

```

You can also add modules to your project with [runnerty]

```bash

npx runnerty add @runnerty/notifier-telegram

```

This command installs the module in your project, adds example configuration in your [config.json] and creates an example plan of use.

If you have installed [runnerty] globally you can include the module with this command:

```bash

runnerty add @runnerty/notifier-telegram

```

### Configuration sample:

Add it in the notification section of the [config.json] file. More information [here](https://docs.runnerty.io/notifiers):

```json

{

  "id": "telegram_default",

  "type": "@runnerty-notifier-telegram",

  "token": "ABC123",

  "chat_id": "ABC123"

}

```

Example:

```json

{

  // ...

  "notifiers": [

    {

      "id": "telegram_default",

      "type": "@runnerty-notifier-telegram",

      "token": "MyTokenId",

      "chat_id": "MyChatId"

    }

    //...

  ]

}

```

### Plan sample:

Add 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):

```json

{

  "id": "telegram_default",

  "message": "Process @GV(PROCESS_ID) Running!"

}

```

Examples:

```json

{

  "id": "PROCESS_SAMPLE",

  "name": "Sample process",

  "exec": {

    "id": "shell_default",

    "command": "echo 'Hello world'"

  },

  "notifications": {

    "on_end": [

      {

        "id": "telegram_default",

        "message": "THE PROCESS @GV(PROCESS_ID) HAS FINISHED"

      }

    ]

  }

}

```

- Video:

```json

{

  "id": "PROCESS_SAMPLE",

  "name": "Sample process",

  "exec": {

    "id": "shell_default",

    "command": "echo 'Hello world'"

  },

  "notifications": {

    "on_end": [

      {

        "id": "telegram_default",

        "message": "THE PROCESS @GV(PROCESS_ID) HAS FINISHED",

        "video": "./my_video.mp4"

      }

    ]

  }

}

```

[runnerty]: https://www.runnerty.io

[downloads-image]: https://img.shields.io/npm/dm/@runnerty/notifier-telegram.svg

[npm-url]: https://www.npmjs.com/package/@runnerty/notifier-telegram

[npm-image]: https://img.shields.io/npm/v/@runnerty/notifier-telegram.svg

[david-badge]: https://david-dm.org/runnerty/notifier-telegram.svg

[david-badge-url]: https://david-dm.org/runnerty/notifier-telegram

[config.json]: https://docs.runnerty.io/config/

[notifiers]: https://docs.runnerty.io/notifiers

[plan.json]: https://docs.runnerty.io/plan/