Documentation

opensentinel provides the low-level building blocks you need to get your systems talking to each other.

Whether you're a lone developer or a startup team, these docs will walk you through your options for integrating the opensentinel building blocks into your systems.

Get Started

To get started, either sign up for a free account or login at the dashboard login page. We are currently in an open preview; so if you're up for it and would like to send us feedback we would be deeply grateful!

Supported Integrations

We support the following integrations for Inbound Sources (triggers) and Outbound Destinations (targets). In addition, we also provide a few default Handlers to transform incoming payloads into meaningful output.

Get in touch with us if you would like to see more integrations supported.

Inbound Sources (triggers)

  • Webhooks: you will get a unique URL for each of your opensentinel recipes.

Handlers (transformers)

  • Generic webhook: parses & displays payloads by content-type.
  • GitHub notification: for a subset of GitHub webhook events - sends context-specific messages to chat.
  • Sentry alert: similar to GitHub - parses & sends context-specific messages to your chat channel.

Outbound Destinations (targets)

  • Keybase Chat: sends the handler output to your Keybase team channel or DM - through our automated bot sentinelbot.

Create your first Automation Recipe

An opensentinel automation recipe brings together an automation Source, Handler, and Destination into a complete action to take. It specifies that when traffic comes from a Source, it should be processed by a given Handler, and sent to a specified Destination.

First Automation Recipe Illustration

In this sample walkthrough we're going to create an automation recipe that receives a Webhook request as Source, parses & formats it per Content-Type via the Generic Webhook Handler, and finally sends the results to Keybase as the Destination.

  1. First, connect your Keybase account to opensentinel (Linked Accounts section of your dashboard).

    Connect keybase account

  2. Then add our managed bot to your Keybase team.

    Add sentinelbot as a restricted bot

  3. Add one of your team channels as a Destination in opensentinel. We'll use the #feedback channel from the @pipernet team we already setup for this demo.

    Add destination result

    We'll rename this opensentinel destination to @pipernet #feedback just so it's clear where it's going. (edit, Rename entry)

  4. Now create a new automation source to get a URL that an external system can use to trigger our recipe.

    Add a new automation source result

    Take note of the URL you receive here because you'll need it in a bit. For clarity let's also rename this source to Customer Feedback.

  5. And finally let's put this all together in an opensentinel automation recipe. Go to the Automation Recipes section of your dashboard and click the Add button. Fill in the New Execution Flow form and hit Save.

    New automation recipe form

  6. Time to test it! Open up your terminal and fire a POST request to the webhook URL you received.

    curl -X POST \
        -H 'Content-Type: application/json' \
        -d '{"message": "This is such a great product, thank you!"}' \
        "https://automations.opensentinel.com/webhook?token=<TOKEN>"
  7. Finally assuming everything worked as planned, you should see a chat message with the payload details:

    New automation payload result