php-censor/docs/en/plugins/campfire.md

28 lines
698 B
Markdown
Raw Permalink Normal View History

2016-07-19 11:12:28 +02:00
Plugin Campfire
2017-01-04 13:22:20 +01:00
===============
2016-07-19 11:12:28 +02:00
2017-07-18 15:54:24 +02:00
This plugin joins a [Campfire](https://campfirenow.com/) room and sends a user-defined message, for example a
"Build Succeeded" message.
2016-07-17 16:20:35 +02:00
2016-07-19 11:12:28 +02:00
Configuration
2017-01-04 13:22:20 +01:00
-------------
2016-07-19 11:12:28 +02:00
2016-07-17 16:20:35 +02:00
### Options
2016-07-19 11:12:28 +02:00
2016-07-17 16:20:35 +02:00
- **authToken** [string, required] - Your Campfire user authentication token.
- **message** [string, required] - The message to send to the room.
- **roomId** [string, required] - Your Campfire room ID number.
- **url** [string, required] - Your Campfire chat room URL.
2016-07-19 11:12:28 +02:00
### Examples
2016-07-17 16:20:35 +02:00
```yml
build_settings:
campfire:
authToken: "campfire auth token"
roomId: "campfire room ID"
url: "campfire URL"
success:
campfire:
message: "Build succeeded!"
```