https://github.com/notify-events/bash

Bash script to integrate your project with Notify.Events service.
https://github.com/notify-events/bash

alert bash bash-script call notification slack teams telegram viber voice

Last synced: about 2 months ago
JSON representation

Bash script to integrate your project with Notify.Events service.

• Host: GitHub
• URL: https://github.com/notify-events/bash
• Owner: notify-events
• License: mit
• Created: 2020-06-14T14:51:32.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-06-21T12:35:24.000Z (over 4 years ago)
• Last Synced: 2024-11-05T19:42:40.751Z (3 months ago)
• Topics: alert, bash, bash-script, call, notification, slack, teams, telegram, viber, voice
• Language: Shell
• Homepage: https://notify.events/source/67
• Size: 5.86 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Bash script for Notify.Events

A simple bash script that simplifies the process of integrating your project with the [Notify.Events](https://notify.events) service to send messages to your channels.

#### Instruction on another languages

- [Русский](/README_RU.md)

# Using instructions

To send a message using a bash script, you need to:

- Add the [Bash source](https://notify.events/source/67) to your Notify.Events channel and get your `token` 

- Place the [notify.events.sh](/notify.events.sh) script file into environment which have Internet connection

- Run the script passing the necessary parameters

Usage example:

```

./notify.events.sh \

    --token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX \

    --text="Hello world" \

    --priority=high \

    --image=/var/log/hourly.jpg \

    --image=/var/log/weekly.jpg \

    --file=/var/log/summary.log

```

# List of available parameters

| Parameter  | Required | Description                                 |

|------------|----------|---------------------------------------------|

| --token    | true     | param to specify your Notify.Events `token` |

| --text     | true     | param to specify message text (allowed html tags: ``, ``, ``, `
`) |

| --title    | false    | message title                               |

| --priority | false    | message priority (available values: `highest`, `high`, `normal`, `low`, `lowest`. Default: `normal`) |

| --level    | false    | message level (available values: `verbose`, `info`, `notice`, `warning`, `error`, `success`. Default: `info`) |

| --file     | false    | attach local file                           |

| --image    | false    | attach local image                          |


You can use the `--file` and `--image` parameters several times in one call to attach multiple files to your message.

Use the `--help` parameter to display script usage instructions.