API wrapper for Flowdock in Perl
Perl
Switch branches/tags
Nothing to show
Pull request Compare This branch is 4 commits behind gphat:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib/Net
Changes
README.mkdn
dist.ini

README.mkdn

NAME

Net::Flowdock - Flowdock API

VERSION

version 0.01

SYNOPSIS

use Net::Flowdock;

my $client = Net::Flowdock->new(key => 'find-your-own');

$client->send({
    source => 'CPAN',
    from_address => 'gphat@cpan.org',
    from_name => 'Cory Watson',
    subject => 'Uploaded Net::Flowdock',
    content => "Sho' nuff",
    project => 'Open Source',
    tags => 'wow,yeah,poop',
    link => 'http://search.cpan.org'
});

DESCRIPTION

Net::Flowdock is a simple client for using the Flowdock API.

ATTRIBUTES

debug

Set/Get the debug flag.

key

Set/Get the key to use when connecting to Flowdock.

To obtain the API Token go to Settings -> Team Inbox inside a flow.

url

Set/Get the URL for Flowdock. Defaults to https://api.flowdock.com.

METHODS

send ({ source => $source, from_address => $email })

Required fields:

  • source

Human readable identifier of the application that uses the Flowdock API. Only alphanumeric characters, underscores and whitespace can be used. This identifier will be used as the primary method of categorization for the messages.

Example value: Awesome Issue Management App

  • from_address

Email address of the message sender. The email address is used to show a avatar of the sender. You can customize the avatar by registering the address in

Example value: john.doe@yourdomain.com

  • subject

Subject line of the message, will be displayed as the title of Team Inbox message.

  • content

Content of the message, will be displayed as the body of Team Inbox message.

Following HTML tags can be used: a abbr acronym address article aside b big blockquote br caption cite code dd del details dfn div dl dt em figcaption figure footer h1 h2 h3 h4 h5 h6 header hgroup hr i img ins kbd li nav ol p pre samp section small span strong sub summary sup table tbody td tfoot th thead tr tt ul var wb

Optional fields:

  • from_name

Name of the message sender.

Example value: John Doe

  • project

Human readable identifier for more detailed message categorization. Only alphanumeric characters, underscores and whitespace can be used. This identifier will be used as the secondary method of categorization for the messages.

Example value: My Project

  • format

Format of the message content, default value is "html". Only HTML is currently supported.

Example value: html

  • tags

Tags of the message, separated by commas.

Example value: cool,stuff

  • link

Link associated with the message. This will be used to link the message subject in Team Inbox.

Example value: http://www.flowdock.com/

AUTHOR

Cory G Watson gphat@cpan.org

COPYRIGHT AND LICENSE

This software is copyright (c) 2012 by Infinity Interactive, Inc.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.