Lifecycle Webhooks

A limitation with webhooks is that there is no validation that the webhook was received by the destination. No re-attempt requests are made on failures.

We do not recommend using webhooks for auditing purposes as notifications may be lost due to latency or the remote service not being available.

Use the Audit Log for mission-critical message queuing for reporting and monitoring.

Webhooks are created by System Administrators. Webhooks do not have a permissions model and will send HTTP requests for every configured event. The system consuming the webhooks will have access to all the data provided by the event types.

Webhooks may be consumed with many tools. The following example is a simple service using node.js.

Run the following to initialize the environment. The secret key is saved to a setting.json file.

npm init
npm install express
npm install body-parser
echo {\"secretKey\":\"secretKey\"} > settings.json

Add the code below to a file named app.js, and run the webhook listener via the command: node app.js

const express = require('express');
const app = express();
const bodyParser = require('body-parser');
const settings = require('./settings.json');
const crypto = require('crypto');

app.use(bodyParser.json());

app.post('/', function(req, res) {
  const body = req.body;
  const signature = req.headers['x-nexus-webhook-signature'];
  var hmacDigest = crypto.createHmac("sha1", settings.secretKey).update(JSON.stringify(body)).digest("hex");

  console.log('Webhook received');
  console.log('Headers: ' + JSON.stringify(req.headers));
  console.log('Body: ' + JSON.stringify(req.body));
  console.log('HmacDigest: ' + hmacDigest);
  console.log('Signature: ' + signature);
  res.send();
});

app.listen(3000, function() {
  console.log('Server running on port 3000.');
});

Additional code may be added to further process the request by connecting with the server APIs to access details on the request.