README.md

XL Release Flowdock plugin

Preface

This document describes the functionality provided by the XL Release Flowdock plugin.

See the XL Release Documentation for background information on XL Release and release orchestration concepts.

Overview

The XL Release Flowdock plugin is a XL Release plugin that adds capability for sending message to a Flowdock inbox.

Requirements

• Requirements
  • v1.0.0-v1.3.0: XL Release 6.0.x - 7.2.x
  • v1.4.0: XL Release 8+
  • Event-based notifications are not supported in XL Release 7.5.x and 7.6.x.

Installation

• Copy the latest JAR file from the releases page into the XL_RELEASE_SERVER/plugins directory.
• Restart the XL Release server.

Usage

Event based notifications

1. Go to Settings - Shared configuration - Flowdock: Configuration.
2. Add a new configuration.
3. Provide Title (can be anything), API url (eg: https://api.flowdock.com), Flow token (see your Flow configuration in Flowdock) and enable or disable the Flowdock configuration.
4. Each time XL Release stores something into the Activity logs, this will also be send to Flowdock.
5. The SendTeamInboxMessage task can also use this configuration item.

Flowdock server

For the Post Message task, configure a Flowdock Server.

1. Go to Settings - Shared configuration - Flowdock: Server.
2. Add a new server.
3. Provide Title (can be anything) and API url (eg: https://api.flowdock.com).

Tasks

Send Team Inbox Message

Send a specific message to a Team Inbox. This task should be configured with a Flowdock configuration and a flow token that is not associated with a source.

Post Message

Send a specific message to a flow (inbox) using the Messages API. This task should be configured with a Flowdock server and a flow token that is associated with a source. See https://www.flowdock.com/api/integration-getting-started.