Webhook

Overview

Observo alerts supports integration with any custom webhook endpoint. This document provides instructions on configuring webhook channels to receive alerts triggered from Observo.

Configure Webhook

Observo sends alerts to webhook endpoints using HTTP POST requests. You need two main components to set up a webhook channel:

  1. Webhook URL: The endpoint URL where alerts will be sent

  2. Headers: Optional HTTP headers for authentication or any other custom requirements

Authentication

Depending on your webhook endpoint's requirements, you can configure authentication using HTTP headers. Here are common authentication methods:

Basic Authentication

To use Basic Authentication, add the following header:

Authorization: Basic <base64-encoded-credentials>

Where <base64-encoded-credentials> is the base64 encoding of username:password

Bearer Token

To use Bearer Token authentication, add the following header:

Authorization: Bearer <your-token>

Where <your-token> is your authentication token

Custom Headers

You can also add any other custom headers required by your webhook endpoint:

X-API-Key: your-api-key
Custom-Header: custom-value

Example Configurations

  1. Basic Auth Example:

    • Webhook URL: https://webhook.example.com/alerts

    • Headers:

      Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
  2. Bearer Token Example:

    • Webhook URL: https://api.example.com/webhook

    • Headers:

      Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
  3. Headers API Key Example:

    • Webhook URL: https://alerts.example.com/endpoint

    • Headers:

      X-API-Key: your-api-key-here

Last updated

Was this helpful?