Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/smartiniongithub/fastify-webhook
Fastify Plugin to serve webhooks with some default settings
https://github.com/smartiniongithub/fastify-webhook
fastify fastify-plugin webhook webhooks
Last synced: 7 days ago
JSON representation
Fastify Plugin to serve webhooks with some default settings
- Host: GitHub
- URL: https://github.com/smartiniongithub/fastify-webhook
- Owner: smartiniOnGitHub
- License: apache-2.0
- Created: 2018-03-21T17:25:12.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-28T18:30:53.000Z (almost 2 years ago)
- Last Synced: 2024-12-06T17:14:24.654Z (19 days ago)
- Topics: fastify, fastify-plugin, webhook, webhooks
- Language: JavaScript
- Size: 85.9 KB
- Stars: 5
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# fastify-webhook
[](https://npmjs.org/package/fastify-webhook/)
[](https://npmjs.org/package/fastify-webhook/)
[](http://standardjs.com/)
[](http://opensource.org/licenses/APACHE-2.0)
Fastify Plugin to serve webhooks with some useful default settings.
With this plugin, Fastify will have a route configured for `/webhook` POST requests.
## Usage
```js
const fastify = require('fastify')()
// example without specifying options, returning a default webhook mapped to '/webhook' that only acknowledge the POST request
fastify.register(require('fastify-webhook'))
// or
// example with custom webhook url and handler, and secret key
// fastify.register(require('fastify-webhook'), {'url': '/custom-webhook', 'handler': myWebhookHandler, 'secretKey': 'secret key'})
//
// note that to use one of handlers bundled with the plugin, you need to get a reference to the plugin script 'src/handlers', and then as handler pass a reference to desired function, like:
// const webhookHandlers = require('fastify-webhook/src/handlers') // get plugin handlers (optional)
// const webhookPlugin = require('fastify-webhook')
// fastify.register(webhookPlugin, { 'url': '/custom-webhook', 'handler': webhookHandlers.echo, 'secretKey': 'secret key'})
//
fastify.listen(3000)
// To test, for example (in another terminal session) do:
// curl http://127.0.0.1:3000/webhook -X POST -H 'Content-Type: application/json' -d '{"payload":"test"}' => returning a JSON dump of the given data, and no thrown error
// in Windows you need to escape double quote char in the given json body, so do:
// curl http://127.0.0.1:3000/webhook -X POST -H "Content-Type: application/json" -d "{\"payload\":\"test\"}"
// or put data in a json file and pass with something like: '-d @body.json'
```
In the [example](./example/) folder there are some simple server scripts that uses the plugin (inline but it's the same using it from npm registry).
## Requirements
Fastify ^4.0.1 , Node.js 14 LTS (14.15.0) or later.
Note that plugin releases 3.x are for Fastify 3.x, 4.x are for Fastify 4.x, etc.
## Sources
Source code is all inside main repo:
[fastify-webhook](https://github.com/smartiniOnGitHub/fastify-webhook).
Documentation generated from source code (library API):
[here](https://smartiniongithub.github.io/fastify-webhook/).
## Note
By default the plugin map a default handler on the URI `/webhook` to be called via POST, otherwise it's possible to change via the setting 'url' in plugin options.
The plugin exposes some handlers, for common base operations (and webhook debug help).
To use one of them, before registering the plugin, you need to get a reference from its `src/handlers` source file;
then you can configure the desired one in the setting 'handler' in plugin options.
They are:
- `acknowledge` (default handler) that simply acknowledge the request, and reply with a simple json response
- `echo` it dumps the given input data in the (json) response
- `logger` it dumps some info on the request using Fastify logger
but of course for a real world usage you need to specify your own handler function, with arguments '(request, reply)'.
Otherwise you can use yours, with signature `function handler (request, reply)`.
Other plugin options:
- 'disableWebhook' (default false) to disable the registration of the route for the webhook
- 'enableGetPlaceholder' (default false) to publish via GET a route with the same path of the webhook but returning an HTTP Error 405 Method Not Allowed
- 'secretKey' (default null) to specify a string as secret key that callers of the webhook must provide, or webhook will reply with an error
- 'preHandlers' is a list of functions to be used as preHandler in the specific route of the webhook; currently the list contains an internal function to check the secret key (if given); otherwise you can define and use yours, with signature `function preHandler (request, reply, done)`.
Note that there is not a good general way to handle (usually user-specific) token in requests, so this is not managed via the plugin, but in examples and tests you can find some info.
## License
Licensed under [Apache-2.0](./LICENSE).
----