Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jenkinsci/notify-events-plugin
This plugin allows you to send messages from Jenkins jobs to Telegram, Viber, Skype, SMS, Voice Call and many others.
https://github.com/jenkinsci/notify-events-plugin
alert call notification slack teams telegram viber voice
Last synced: about 2 months ago
JSON representation
This plugin allows you to send messages from Jenkins jobs to Telegram, Viber, Skype, SMS, Voice Call and many others.
- Host: GitHub
- URL: https://github.com/jenkinsci/notify-events-plugin
- Owner: jenkinsci
- License: mit
- Created: 2020-05-07T22:27:20.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-09-12T09:56:14.000Z (over 3 years ago)
- Last Synced: 2024-08-25T00:41:55.070Z (5 months ago)
- Topics: alert, call, notification, slack, teams, telegram, viber, voice
- Language: Java
- Homepage: https://notify.events/ru/source/jenkins
- Size: 74.2 KB
- Stars: 10
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Notify.Events [](https://ci.jenkins.io/job/Plugins/job/notify-events-plugin/job/master/)
This plugin allows **Jenkins** to send notification to:
- Telegram
- Viber
- SMS
- Slack
- Jabber / XMPP
- Discord
- Web Push
- Microsoft Teams
- Voice calls
See the full list of supported messengers [here](https://notify.events/en-US/features).
#### Read the manual in other languages
- [Русский](docs/ru-RU.md)
## Installation
### Option 1. Plugin Manager
1. Go to **Manage Jenkins** > **Manage plugins** > **Available**.
2. Search for **Notify.Events**.
3. Check the box next to the found plugin and click **Install without restart**.
### Option 2. Downloading a .hpi file
1. Download the latest **notify-events.hpi** release [here](http://archives.jenkins-ci.org/plugins/notify-events/latest/notify-events.hpi).
2. Manually install the plugin on the Jenkins controller. Read full instructions for advanced plugin installation [here](https://jenkins.io/doc/book/managing/plugins/#advanced-installation).
### Option 3. Building from the source
1. To build the plugin, run `mvn install`. This will create the **./target/notify-events.hpi** file.
2. Manually install the plugin on the Jenkins controller. Read full instructions for advanced plugin installation [here](https://jenkins.io/doc/book/managing/plugins/#advanced-installation).
## Basic usage
### Createing a channel in Notify.Events
1. Sign-up to the [Notify.Events](https://notify.events/user/sign-in) service.
2. Create a new channel.
3. Add Jenkins as a source to your channel.
4. Copy your token and save the integration.
### Jenkins build configuration
#### Build Step
1. Add a build step.
2. Paste the copied **Token** (see Create a Notify.Events channel, step 4).
3. Fill in the **Message** field.
#### Post-build Actions
1. Add a post-build step.
2. Paste the copied **Token** (see Create a Notify.Events channel, step 4).
3. Fill in the **Message** (optional).
4. Fill in the **Send when** field.
#### Pipeline
```
notifyEvents message: 'Hello world', token: '01234567890123456789012345678901'
```
### Formatting
You can use environment variables (including Token-Macro) and simple HTML formatting (``, ``, `` tags) for the Title and Message fields.
Example:
```html
$BUILD_ID - Built successfully
```