How dfir-iris/iris-webhooks-module works
Project type and purpose
• This is a small Python “Processor” module for the IRIS platform.
• Its sole purpose is to expose an interface that IRIS can invoke at runtime which in turn calls out to arbitrary external HTTP(S) webhooks.
File structure
• Top-level files:
• README.md, LICENSE.txt, requirements.txt, setup.py, .gitignore
• iris_webhooks_module/ package:
• IrisWebHooksConfig.py – defines how you store and retrieve webhook endpoints, headers, timeouts, etc.
• IrisWebHooksInterface.py – defines the processor interface class that IRIS will discover and call.
• __init__.py – package entry point.
• There are no separate “frontend” or “backend” folders; this is purely a plugin library.
Readme insights
• Module type: “Processor”
• Installed into an IRIS Docker container via pip
• Configuration is externalized (via IRIS config files) and documented on the IRIS docs site.
a. Main components
• IRIS Core Engine (running in Docker)
• IrisWebHooksModule (Python package loaded into IRIS)
• Configuration Store (IRIS module configuration mechanism)
• External Webhook Endpoints (any HTTP/S service)
b. Relationships & data flows
1. IRIS Core receives an event or is triggered by a user workflow.
2. IRIS Core instantiates the IrisWebHooksInterface class.
3. The module reads settings from IrisWebHooksConfig (via IRIS’s config APIs).
4. The module makes outbound HTTP(S) calls to one or more external webhook URLs.
5. Responses (or errors) are returned into IRIS and passed back to the caller.
c. Architectural patterns and principles
• Plugin/processor architecture: IRIS discovers and loads modules at runtime.
• Dependency inversion: The module depends on abstract IRIS interfaces rather than concrete callers.
• Configuration-as-code: All webhook URLs and credentials live in a separate config component.
d. Key technologies
• Python 3.x, pip packaging (setup.py, requirements.txt)
• IRIS’s Python extension APIs (to register a Processor)
• Standard HTTP library (e.g., requests) under the covers
• Docker (IRIS runs in a container; module installed via pip in that container)