Code Monkey home page Code Monkey logo

firebase-webhook's Introduction

firebase-webhook

npm version

firebase-webhook provides the ability to send WebHooks based on updates to a specified path in a Firebase Realtime Database.

Installation

This module is installed via NPM:

$ npm install --save firebase-webhook

Usage

Import the module:

const fbwebhook = require('firebase-webhook');

Authenicate your app with Firebase using Firebase Admin Node.js SDK

Create a subscription:

const webhookOpts = {
  endpoint: 'https://requestb.in/abcdef',
  headers:  {"X-Hello" : "World"},
  data: ['name', 'email']
}

fbwebhook.subscribe('users/', webhookOpts);

API

Subscribe

Listen for updates to a specific path in Firebase.

fbwebhook.subscribe(path : String, options: Object);
Options

endpoint {String} The webhook endpoint for this subscription.

headers {Object} Key value pairs of custom http headers for the WebHook POST.

data {Array} Specify which nodes of the updated child will be sent with the WebHook payload.

Todos

  • Test coverage

License

MIT

firebase-webhook's People

Contributors

js-kyle avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.