Find file History
safaorhan docs(twitter): add slackin badge
Updates to add the slackin badge with link.
Latest commit 6f607ba Sep 19, 2017

npm node deps tests bithound bithoundscore nsp-checked

Broid Twitter 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.

Getting started


npm install --save @broid/twitter

Connect to Twitter

const BroidTwitter = require('@broid/twitter');

const twitter = new BroidTwitter({
  username: '@mention',
  token: "<access_token>",
  tokenSecret: "<access_secret>",
  consumerSecret: "<consumer_secret>",
  consumerKey: "<consumer_key>"

    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
tokenSecret string Your access token secret
consumerSecret string Your consumer secret
consumerKey string Your consumer key
username string Your username to listen Twitter mention

Receive a message

    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": "",
  "type": "Create",
  "generator": {
    "id": "f6e92eb6-f69e-4eae-8158-06613461cf3a",
    "type": "Service",
    "name": "twitter"
  "object": {
    "type": "Note",
    "content": "hello world"
  "to": {
    "type": "Person",
    "id": "152486124831181614"

  .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


Copyright & License

Copyright (c) 2016-2017

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