@runnerty/notifier-telegram

Smart Processes Management

Telegram notifier for Runnerty:

Installation:

Through NPM

npm i @runnerty/notifier-telegram

You can also add modules to your project with runnerty-cli

npx runnerty-cli add @runnerty/notifier-telegram

This command installs the module in your project, adds example configuration in your config.json.

If you have installed runnerty-cli globally you can include the module with this command:

rty add @runnerty/notifier-telegram

Configuration sample:

Add it in the notification section of the config.json file. More information here:

{
  "id": "telegram_default",
  "type": "@runnerty-notifier-telegram",
  "token": "ABC123",
  "chat_id": "ABC123"
}

Example:

{
  // ...
  "notifiers": [
    {
      "id": "telegram_default",
      "type": "@runnerty-notifier-telegram",
      "token": "MyTokenId",
      "chat_id": "MyChatId"
    }
    //...
  ]
}

Plan sample:

Add add it to any chain or process notification event. More information here:

{
  "id": "telegram_default",
  "message": "Process @GV(PROCESS_ID) Running!"
}

Examples:

{
  "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:

{
  "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"
      }
    ]
  }
}