Webhooks
Webhooks send what happens in your workspace to your own systems as it happens. Add an endpoint in the command centre under Settings, Developers.
import { Webhook } from 'standardwebhooks';
const wh = new Webhook(process.env.XOVRIS_WEBHOOK_SECRET);// throws unless the signature, the id and the timestamp all matchconst event = wh.verify(rawBody, { 'webhook-id': req.headers['webhook-id'], 'webhook-timestamp': req.headers['webhook-timestamp'], 'webhook-signature': req.headers['webhook-signature'],});The events
Section titled “The events”| Event | Sent when |
|---|---|
alert.fired |
an alert is raised |
alert.resolved |
an alert clears |
incident.opened |
an incident opens |
incident.resolved |
an incident is resolved |
fix.proposed |
a fix is ready for a decision |
fix.applied |
a fix is applied |
fix.verified |
the re-run check proves the fix |
fix.rolled_back |
a fix that did not pass its re-check is put back |
change.made |
Xovris makes any other change |
webhook.test |
you press Send a test |
Verifying a delivery
Section titled “Verifying a delivery”Every delivery follows the Standard Webhooks specification: the headers
webhook-id, webhook-timestamp and webhook-signature, the signature over the id, the timestamp and the body. Any
Standard Webhooks library verifies it with your endpoint’s secret.
Works with every official library
Section titled “Works with every official library”Xovris’s signatures verify with all nine official Standard Webhooks libraries: each accepts every kind of event Xovris sends and refuses a changed body, a changed id, another endpoint’s secret and a timestamp more than five minutes old or ahead. Two of them need one thing from you.
| Language | Library | What to know |
|---|---|---|
| JavaScript | standardwebhooks (npm) |
Nothing extra. |
| Python | standardwebhooks (PyPI) |
Nothing extra. |
| Go | github.com/standard-webhooks/standard-webhooks/libraries/go |
Nothing extra. |
| C# | StandardWebhooks.StandardWebhooks (NuGet) |
The package named only StandardWebhooks is another vendor’s. |
| Rust | standardwebhooks (crates.io) |
Nothing extra. |
| Java | com.standardwebhooks:standardwebhooks (Maven Central) |
Nothing extra. |
| Ruby | standardwebhooks (RubyGems) |
On Ruby 3.4 or later, add the base64 gem too: the library needs it and does not say so. |
| PHP | standard-webhooks/standard-webhooks (Packagist) |
Nothing extra. |
| Elixir | libraries/elixir in the standard’s repository (not on Hex) |
Pass the secret without its whsec_ prefix, and decode the body with Jason’s ordered objects before verifying: the library re-encodes the body it checks. |
Every delivery, with your receiver’s answer
Section titled “Every delivery, with your receiver’s answer”Each endpoint lists its deliveries with the status and body your receiver returned. A delivery that is not accepted is tried again after 5 seconds, 5 minutes, 30 minutes, 2 hours, 5 hours, 10 hours and 10 hours more. From the same list you can send a test, re-key the endpoint’s secret or switch the endpoint off.
Your data is never used to train our AI. How your data is kept
A problem is called fixed only once it works again. How each fix is checked
XOVRIS LTD, registered in England and Wales, company number 17499910. Registered office: 66 Paul Street, London EC2A 4NA.