Skip to content
This repository was archived by the owner on Feb 8, 2020. It is now read-only.

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

npm node deps tests bithound bithoundscore nsp-checked

Broid Flowdock Integration

Broid Integrations is an open source project providing a suite of Activity Streams 2 libraries for unified communications among a vast number of communication platforms.

Connect your App to Multiple Messaging Channels with One OpenSource Language.

gitter slackin

Message types supported

Simple Image Video Buttons Location Phone number

Buttons, Location, Phone number are platform limitations.

Image, Video are supported as a simple message

Threads are supported

Getting started

Install

npm install --save @broid/flowdock

Connect to Flowdock

const BroidFlowdock = require('@broid/flowdock');

const flowdock = new broidFlowdock({
  token: "<access_token>"
});

flowdock.connect()
  .subscribe({
    next: data => console.log(data),
    error: err => console.error(`Something went wrong: ${err.message}`),
    complete: () => console.log('complete'),
  });

Options available

name Type default Description
serviceID string random Arbitrary identifier of the running instance
logLevel string info Can be : fatal, error, warn, info, debug, trace
token string Your access token

Receive a message

flowdock.listen()
  .subscribe({
    next: data => console.log(`Received message: ${data}`),
    error: err => console.error(`Something went wrong: ${err.message}`),
    complete: () => console.log('complete'),
  });

Post a message

To send a message, the format should use the broid-schemas.

const formatted_message = {
  "@context": "https://www.w3.org/ns/activitystreams",
  "type": "Create",
  "generator": {
    "id": "f6e92eb6-f69e-4eae-8158-06613461cf3a",
    "type": "Service",
    "name": "flowdock"
  },
  "object": {
    "type": "Note",
    "content": "hello world",
    "tag": [
      {
        "id": "my_tag",
        "name": "my_tag",
        "type": "Object"
      }      
    ]
  },
  "to": {
    "id": "bd9b6be2-f2b9-4018-ae6d-372aa68e3f5a",
    "type": "Group"
  }
};

flowdock.send(formatted_message)
  .then(() => console.log("ok"))
  .catch(err => console.error(err));

Examples of messages

You can find examples of sent and received messages at Broid-Schemas.

Contributing to Broid

See CONTRIBUTE.md

Copyright & License

Copyright (c) 2016-2017 Broid.ai

This project is licensed under the AGPL 3, which can be found here.