adicionar suporte ao typescript:

declare module 'node-webhooks' {
import type { EventEmitter2 } from 'eventemitter2';

interface WebHookOptions {
db: string | Record<string, string[]>;
httpSuccessCodes?: number[];
}

type WebHookCallback = (
shortname: string,
jsonData: any,
headersData?: Record<string, string>
) => void;

class WebHooks {
constructor(options: WebHookOptions);

trigger(shortname: string, jsonData: any, headersData?: Record<string, string>): void;

add(shortname: string, url: string): Promise<boolean>;

remove(shortname: string, url?: string): Promise<boolean>;

getDB(): Promise<Record<string, string[]>>;

getWebHook(shortname: string): Promise<string[]>;

getListeners(): Record<string, WebHookCallback>;

getEmitter(): EventEmitter2;

}

export = WebHooks;
}

hello i want to reset all the webhoock when the server is restarted. i'm trying to remove the db param but i get an error like this:

db Must be a String path

Improvement:

• refactor to be standard-compliant.

CI Tests:

• feross/standard.
• nsp

I was trying to call the webhooks.trigger('ticket_upsert', { data: "1" }) and setup the webhooks like this

const db =  {
        "ticket_upsert" : [
            "https://webhook.site/563f5326-da57-4a1b-ba3b-82686832694f", 
            "https://webhook.site/563f5326-da57-4a1b-ba3b-82686832694f", 
            "https://webhook.site/563f5326-da57-4a1b-ba3b-82686832694f"
        ]
    }

 const webHooks = new nodeWebHooks({ db })

The problem is the webhooks pushes 3times on the same URL, so like the first url "https://webhook.site/563f5326-da57-4a1b-ba3b-82686832694f", was called 3 times. I was triggerring it once. I'm expecting that it will call only once, for each URL

----update

i guess the problem lies on instantiate of new nodeWebHooks({ db }), i did instantiate it on my class constructor, and that class was called 3 times on several places. Disregard this issue, i was able to solve it

• Tests coverage with Istanbul.
• coverall.io badge.

Increase test coverage.
Right now it's at 79%.

Why does node-webhooks only fire the success event, if the response has a http status code of 200?
In my opinion at least 201 till 204 are also valid and common response codes.

Would it be possible to add retries, i.e:

retries: 3
retryDelay: 30

If the returned status code is not one of httpSuccessCodes or a timeout, automatically retry the request using the above logic. Defaults to 0 retries.

• test and publish on NPM the new 1.1.1 release.

`
// Initialize webhook
const webHooks = new Webhooks({
db: './webHooksDB.json',
httpSuccessCodes: [200, 201, 202, 203, 204],
})

    // Encode key
    const base64Key = Buffer.from(`/vnf-agent/vpp1/config/generator/v1/template/${state.projectName}`).toString('base64')
    const base65Key = Buffer.from(`/vnf-agent/vpp1/config/generator/v1/project/${state.projectName}`).toString('base64')


    // Add webhook watcher onto etcd /template keys
    webHooks.add("etcd", 'http://localhost:2379/v3beta/watch')
    webHooks.add("project", 'http://0.0.0.0:2379/v3beta/watch')

    // Trigger webhook & send watch request
    webHooks.trigger("etcd", { key: base64Key })
    webHooks.trigger("project", { key: base65Key })

    // Shows emitted events
    const emitter = webHooks.getEmitter()
    emitter.on("*.success", (name, statusCode, response) => {
        console.log('SUCCESS triggering webHook ' + name + ' with status code', statusCode, 'and body', body)

        // Create object from string response
        const body = JSON.parse(response)

        // Decode value
        let value = body.kvs[0].value.toString()
        value = Buffer.from(value, 'base64')

        // Decode tar
        let buffer = JSON.parse(value)
        buffer = Buffer.from(buffer.tar_file, 'base64')

        // Displays code to frontend
        fs.appendFile('public/code.txt', buffer, function (err) {
            if (err) throw err;
            console.log('Saved!');
        });

        // Create tar folder
        fs.appendFile('public/template.tgz', buffer, function (err) {
            console.log('Saved!');
        });

    })`

We're using our webhook to grab a response for a specified key on ETCD. Everything was good and working properly, where all of a sudden for some reason the code stopped working. We were originally getting an error such as:

MaxListenersExceededWarning: (node) warning: possible EventEmitter memory leak detected. 11 listeners added. Use emitter.setMaxListeners() to increase limit.

Where once we fixed this (by properly calling webhook.remove()), the error went away but the emitter does not pick up anything. We know the key is being properly inserted into ETCD, and the emitter was working properly, except now it doesn't work at all with no change to the code itself. Is there something you could think of that might have caused this? We even went into your source code and tried to set the webhooks.emitter = new EventEmitter2({ newListener: true, wildcard: true }) as we noticed EventEmitter2 for us had newListener set to false on default for some reason. Thanks!

@roccomuso thanks for the package, I'm using this node-webhooks in multiple projects/companies from around 3+ years

Simplicity and minimalist design of the node-webhooks helped in wide and faster adoption.

as the application scales, the reliability of the webhook delivery becomes challenging. Migrating from node-webhooks will additional learning for all developers across company.

After so much research, I thought to discuss with node-webhooks contributors to build

• storage adapter
  • subscriptions
  • ingestion/deliveries - in case of spike/failures
  • logs
• UI for debugging
  • at production
  • while development

This requirement might not be in the code of this repo. but to discuss about overall integrations i created issue here

when there is no storage adapter is specified, automatically fallback to normal module

configurations should be there to tune based on use cases

for Persistence

• MongoDB
• MySQL/SQLite

for Messaging

• SQS/RabbitMQ
• Redis

For Logging

• ElasticSearch

For Debugging

• UI for Developer Debugging and Production failure retries

Research

• https://hookdeck.io/

Actions

Phase1:

• Logging
• Dashboard to retry
  https://github.com/manjeshpv/node-webhooks-dashboard

• code refactor.
• write tests.
• configure Travis CI.
• add Travis badge on the README.md

hi,
I'm trying using WebHooks to call a php rest on localhost when an alarm is triggered.
The WebHook calls the rest, but there is no json payload in the request. Here are the data about http headers catched by my php rest:

Content-Type:application/json
host:localhost
content-length:0
Connection:close

also the data readed by the following instructions:
$request_body = file_get_contents('php://input');
$data = json_decode($request_body);
results empty

API Example

var WebHooks = require('node-webhooks')
var InMemory = require('webhooks-memory-storage')
var FileStorage = require('webhooks-file-storage')

var webHooks = new WebHooks({
    db: new InMemory(),  // in-memory DB
    //db: new FileStorage('./webHooksDB.json'), // json file that store webhook URLs
    // redis, mongoDB, lokiJS, levelDB etc.
});

WebHooks Storage Implementation

Every webHooks store must be an EventEmitter and implement specific methods. The following methods are the list of required, recommended, and optional.

• Required methods are ones that this module will always call on the store.
• Recommended methods are ones that this module will call on the store if available.
• Optional methods are ones this module does not call at all, but helps present uniform stores to users.

I am looking to implement webhook calls. I don't need a dynamic DB so I would not make use of add, etc. Therefor it would be great to be able to use a static DB, checked into revision control along the project. What is the json syntax of the current db? Is the syntax stable?

EDIT:

Ok, found it. Scrolled down too fast.

DB Structure Example:
{
	"shortname1": [url1, url2, ...],
	"shortname2": [url3, url4, ...],
	 ...
	 ...
	"shortnameX": [urlZ, ...]
}

Would be nice to be able to set this as plain object.

    // Initialize WebHooks module.
    var WebHooks = require('node-webhooks')
    // Initialize webhooks module from on-disk database
    var webHooks = new WebHooks({
        db: './webHooksDB.json', // json file that store webhook URLs
        httpSuccessCodes: [200, 201, 202, 203, 204], //optional success http status codes
    })
    webHooks.add('test', 'http://127.0.0.1:9000/test').then(function(){
        // done
    }).catch(function(err){
        console.log(err)
    })

    var emitter = webHooks.getEmitter()
    
    emitter.on('*.success', function (shortname, statusCode, body) {
        console.log('Success on trigger webHook' + shortname + 'with status code', statusCode, 'and body', body)
    })
    
    emitter.on('*.failure', function (shortname, statusCode, body) {
        console.log(shortname)
        console.error('Error on trigger webHook' + shortname + 'with status code', statusCode, 'and body', body)
    })`

While trigger the webhook "let wb = webHooks.trigger('test', {data: 123456}, {header: 'header'})" got this error Error on trigger webHookshortname1with status code null and body null

The documentation is very brief, uninformative, and assumes the reader already has knowledge of many things mentioned.

In my use case, I have a service that looks something like: POST /resource/:id
and I want to direct my webhook to that service based on the POST request body sent into the webhook. So if the POST to /my-webhook is { id: 'xyz' }, it directs to /resource/xyz.

See PR here: #22

Correct me if m wrong, I saw that the function accepts only POST request.
I wonder if there is a way to specify URL method.

hello i need to send a additional data on trigger event for use it after on succes event, for example:

webHooks.trigger(shortName, payloadData, additionalData);

emitter.on('*.success', (shortname, statusCode, body, additionalData)=> {
            //here i need to use the data that i send as parameter in the trigger event
           //how can i do that?
});

thanks