README.md

OverOps WebHook Examples

For a detailed explanation of the OverOps WebHook functionality please visit https://doc.overops.com/docs/outgoing-webhook

This project provides an few WebHook examples using SpringBoot. This same functionality could be implemented in a variety of frameworks or tools but I prefer SpringBoot.

Getting Started

To get started simply run the following command or use your IDE of choice.

./mvnw spring-boot:run

By default, this will start up the provided examples running inside an embedded tomcat instance listening on port 8090. This can be easily changed by modifying application.properties, etc.

To begin receiving events, enable "Webhook" alerts on any OverOps View. You should provide one of the following URL's to OverOps.

http://<your host name or ip>:8090/wh/simple
http://<your host name or ip>:8090/wh/pivotal-tracker
http://<your host name or ip>:8090/wh/mattermost

Keep in mind, these need to be accessible from the OverOps server (SaaS or On-prem). You can also visit my Docker Demos repo for an complete on-prem example: https://github.com/timveil/docker-demos/tree/master/onprem/webhook-example

If you're using Docker for Mac, like I am for most testing, you can use the following base URLs.

http://host.docker.internal:8090/wh/simple
http://host.docker.internal:8090/wh/pivotal-tracker
http://host.docker.internal:8090/wh/mattermost

Customizing

To create your own WebHook integrations, feel free to fork this repo. Most of the heavy lifting has been done for you (binding of OverOps data to Java), simply add your logic to one of the Controller methods or otherwise rename and refactor

@PostMapping(value = "/wh/custom", consumes = MediaType.APPLICATION_JSON_VALUE)
public void myCustomWebhookHandler(@RequestBody Event event) {

    if (event.getType().equals(Event.Type.TEST)) {
        return;
    }

    // add your custom logic here to do something with the Event...
} 

Pivotal Tracker

One of the examples i've included is a very simple Pivotal Tracker integration which automatically creates a Tracker story when the WebHook url is called. Obviously this could be significantly improved by leveraging additional Tracker fields or providing more OverOps data directly in the story. This example along with others is really designed to show the art of the possible for integrations that are not yet "out of the box". To use this example just update the following properties in application.properties.

webhook.pivotal.api.url=https://www.pivotaltracker.com
webhook.pivotal.api.project.id=
webhook.pivotal.api.token=

This example also uses Thymeleaf templates to create Tracker compliant markdown for text fields. This allows richer formatting for data.

Mattermost

This example shows how to quickly send OverOps alerts to a Mattermost channel. An easy way to get up and running with Mattermost is the Docker command below.

docker run --name mattermost-preview -d --publish 8065:8065 --add-host dockerhost:127.0.0.1 mattermost/mattermost-preview

Mattermost users simply need to enable Incoming Webhooks and generate a Incoming Webhook url and token. Then update the following properties in application.properties

webhook.mattermost.url=<incoming webhook url and token>
webhook.mattermost.channel.override=<override channel specified in webhook url.  not required.>
webhook.mattermost.username.override=<override username specified in webhook url.  not required.>

Docker

I created a Docker image if that's your thing.

Building the Image

docker build --no-cache -t timveil/oo-webhook-example:latest .

Publishing the Image

docker push timveil/oo-webhook-example:latest

Running the Image

docker run -it timveil/oo-webhook-example:latest