integrations
1.0.0
Connect your App to Multiple Messaging Channels in a Single Integration with W3C Open standard.
Broid Integrations is an open source project released by Broid that allows you to easily converse on all the major communication platforms (messaging & voice) without integrating each API.
It provides a suite of libraries to convert all messaging platforms events to Activity Streams 2 schemas.
TL;DR
With billions of daily users Messaging is now the prefered channel of communication but there is a clear lack of open standard for the various APIs.
Each one come with a specfic schema, docs, etc. We want to empower the community to built great things with messaging so we open-sourced our Premium API so that you can avoid the tedious work of integrating new channels and focus on your core product .
A quick example showing off listening for new messages on Facebook Messenger and Discord with Observables.
npm i --save @broid/messenger @broid/discord rxjs ramdaconst Rx = require("rxjs/Rx");
const BroidDiscord = require("@broid/discord");
const BroidMessenger = require("@broid/messenger");
const clients = {
discord: new BroidDiscord({token: 'DISCORD_TOKEN'}),
messenger: new BroidMessenger({token: 'FACEBOOK_TOKEN', tokenSecret: 'FACEBOOK_SECRET'})
};
Rx.Observable.merge(...Object.values(clients).map(client => client.connect()))
.subscribe({
next: data => console.log(JSON.stringify(data, null, 2)),
error: err => console.error(`Something went wrong: ${err.message}`),
});
Rx.Observable.merge(...Object.values(clients).map(client => client.listen()))
.subscribe({
next: message => console.log(JSON.stringify(message, null, 2)),
error: err => console.error(`Something went wrong: ${err.message}`),
});Here are 2 quick tutorials to get started with broid in under 5 minutes and 30 lines of codes :
Broid Integrations support simple, media and rich messages (location, carroussel) and split into multiple libraries.
This make Broid flexible and useful to use in your application.
| Name | Status | |
|---|---|---|
| broid-alexa | ||
| broid-callr | ||
| broid-discord | ||
| broid-flowdock | ||
| broid-gitter | ||
| broid-google-assistant | ||
| broid-groupme | ||
| broid-irc | ||
| broid-kik | ||
| broid-line | ||
| broid-messenger | ||
| broid-ms-teams | ||
| broid-nexmo | ||
| broid-skype | ||
| broid-slack | ||
| broid-telegram | ||
| broid-twilio | ||
| broid-twitter | ||
| broid-viber | ||
| broid-wechat | ||
| broid-messagebird | ||
| broid-github | ||
| broid-webmessenger |
Broid integrations supports Activity Streams 2.0 and uses broid-schemas package to validate input and output message.
| Name | Status |
|---|---|
| broid-schemas |
See CONTRIBUTE.md.
To protect the interests of the Broid contributors, Broid, customers and end users we require contributors to sign a Contributors License Agreement (CLA) before we pull the changes into the main repository. Our CLA is simple and straightforward - it requires that the contributions you make to any Broid open source project are properly licensed and that you have the legal authority to make those changes. This helps us significantly reduce future legal risk for everyone involved. It's easy---no faxing or printing required!
You can digitally sign the CLA online. Please indicate your email address in your first pull request so that we can make sure that will locate your CLA. Once you've submitted it, you no longer need to send one for subsequent submissions.
In order to continue providing the community with our open source work, we offer a Public API. Paying users get additionnal features and early access to new integrations:
Only $9.99 per month per active integration
Project cross-browser compatibility supported by BrowserStack
