Skip to content

Files

Latest commit

Mar 11, 2025
c84ce1f · Mar 11, 2025

History

History

webhook

WebHook plugin

BunkerWeb WebHook diagram

This BunkerWeb plugin will automatically send you attack notifications on a custom HTTP endpoint of your choice using a webhook.

Table of contents

Prerequisites

Please read the plugins section of the BunkerWeb documentation first.

Setup

See the plugins section of the BunkerWeb documentation for the installation procedure depending on your integration.

There is no additional services to setup besides the plugin itself.

Docker

services:

  bw-scheduler:
    image: bunkerity/bunkerweb-scheduler:1.6.0-rc1
    ...
    environment:
      - USE_WEBHOOK=yes
      - WEBHOOK_URL=https://api.example.com/bw
    ...

Swarm

services:

  bw-scheduler:
    image: bunkerity/bunkerweb-scheduler:1.6.0-rc1
    ..
    environment:
      - USE_WEBHOOK=yes
      - WEBHOOK_URL=https://api.example.com/bw
    ...

Kubernetes

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: ingress
  annotations:
    bunkerweb.io/USE_WEBHOOK: "yes"
    bunkerweb.io/WEBHOOK_URL: "https://api.example.com/bw"

Settings

Setting Default Context Multiple Description
USE_WEBHOOK no multisite no Enable sending alerts to a custom webhook.
WEBHOOK_URL https://api.example.com/bw global no Address of the webhook.
WEBHOOK_RETRY_IF_LIMITED no global no Retry to send the request if the remote server is rate limiting us (may consume a lot of resources).

TODO

  • Add more info in notification :
    • Date
    • Country of IP
    • ASN of IP
    • ...
  • Add settings to control what details to send :
    • Anonymize IP
    • Add body
    • Add headers