Ghost/core/server/models/webhook.js
Kevin Ansfield bffb3dbd90
Webhooks support for subscriber events (#9230)
no issue

Support for http://resthooks.org style webhooks that can be used with Zapier triggers. This can currently be used in two ways:

a) adding a webhook record to the DB manually
b) using the API with password auth and POSTing to /webhooks/ (this is private API so not documented)

⚠️ only _https_ URLs are supported in the webhook `target_url` field 🚨

- add `webhooks` table to store event names and target urls
- add `POST` and `DELETE` endpoints for `/webhooks/`
- configure `subscribers.added` and `subscribers.deleted` events to trigger registered webhooks
2017-11-21 15:43:14 +00:00

69 lines
2.0 KiB
JavaScript

var ghostBookshelf = require('./base'),
events = require('../events'),
Promise = require('bluebird'),
Webhook,
Webhooks;
Webhook = ghostBookshelf.Model.extend({
tableName: 'webhooks',
emitChange: function emitChange(event, options) {
options = options || {};
events.emit('webhook' + '.' + event, this, options);
},
onCreated: function onCreated(model, response, options) {
model.emitChange('added', options);
},
onUpdated: function onUpdated(model, response, options) {
model.emitChange('edited', options);
},
onDestroyed: function onDestroyed(model, response, options) {
model.emitChange('deleted', options);
}
}, {
findAllByEvent: function findAllByEvent(event, options) {
var webhooksCollection = Webhooks.forge();
options = this.filterOptions(options, 'findAll');
return webhooksCollection
.query('where', 'event', '=', event)
.fetch(options);
},
getByEventAndTarget: function getByEventAndTarget(event, targetUrl, options) {
options = options || {};
options.require = true;
return Webhooks.forge(options).fetch(options).then(function then(webhooks) {
var webhookWithEventAndTarget = webhooks.find(function findWebhook(webhook) {
return webhook.get('event').toLowerCase() === event.toLowerCase()
&& webhook.get('target_url').toLowerCase() === targetUrl.toLowerCase();
});
if (webhookWithEventAndTarget) {
return webhookWithEventAndTarget;
}
}).catch(function (error) {
if (error.message === 'NotFound' || error.message === 'EmptyResponse') {
return Promise.resolve();
}
return Promise.reject(error);
});
}
});
Webhooks = ghostBookshelf.Collection.extend({
model: Webhook
});
module.exports = {
Webhook: ghostBookshelf.model('Webhook', Webhook),
Webhooks: ghostBookshelf.collection('Webhooks', Webhooks)
};