Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/amalfra/mongoose-webhooks
Sends webhook on mongoose model events :mega:
https://github.com/amalfra/mongoose-webhooks
mongoose mongoose-plugin mongoose-webhooks webhook
Last synced: 3 months ago
JSON representation
Sends webhook on mongoose model events :mega:
- Host: GitHub
- URL: https://github.com/amalfra/mongoose-webhooks
- Owner: amalfra
- License: mit
- Created: 2016-06-15T06:02:49.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2023-11-25T06:53:43.000Z (about 1 year ago)
- Last Synced: 2024-09-28T20:43:00.649Z (3 months ago)
- Topics: mongoose, mongoose-plugin, mongoose-webhooks, webhook
- Language: JavaScript
- Homepage:
- Size: 214 KB
- Stars: 2
- Watchers: 3
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Mongoose Webhooks
========
[](https://badge.fury.io/js/mongoose-webhooks)
Sends webhook on mongoose model events.
## Installation
In your project root, run the following:
```sh
npm install mongoose-webhooks
```
## Usage
To use `mongoose-webhooks` plugin in your model you will have to first require the plugin as
```javascript
const mongooseWebhooks = require('mongoose-webhooks');
```
The following schema definition defines a "User" schema, and uses mongoose-webhooks plugin
```javascript
const mongoose = require('mongoose');
const Schema = mongoose.Schema;
// Require the plugin
const mongooseWebhooks = require('mongoose-webhooks');
const User = new Schema({
username : { type : String, required : true},
password : { type : String, required : true },
email : { type : String, required : true},
lastModified : Date,
created : Date
});
// Apply the plugin to schema. Note that the urls option is required.
User.plugin(mongooseWebhooks, {'urls': 'http://site.com/mongoose-webhook'});
// urls options also supports multiple values. You can pass array of values if webhook needs to be delivered to multiple destinations
User.plugin(mongooseWebhooks, {'urls': ['http://site1.com/mongoose-webhook', 'http://site2.com/mongoose-webhook']});
```
Now you will be getting a webhook POST request to configured url. The webhook payload will be
```javascript
{
"event": "save",
"data": {
"__v": 0,
"username": "test",
"password": "test",
"email": "[email protected]"
"_id": "576cf0eacdefabd20a52ac89"
}
}
```
The event key can have following values
* **save** : When the mongoose document is inserted
* **update** : When the mongoose document is updated
* **remove** : When the mongoose document is removed
The data key will have the JSON seralized document from mongoose.
## Options
The two options supported by plugin are
* **urls** : You can specify the URL(s) to send webhook with this option. This accepts multiple values as arrays too. *This is a required option*
* **useragent** : Lets you specify the `User-Agent` header for the webhook request. This is optional.
## Development
Questions, problems or suggestions? Please post them on the [issue tracker](https://github.com/amalfra/mongoose-webhooks/issues).
You can contribute changes by forking the project and submitting a pull request. Feel free to contribute :heart_eyes:
UNDER MIT LICENSE
=================
The MIT License (MIT)
Copyright (c) 2016 Amal Francis
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.