vox-plugin-webhook API Reference (generated)
vox-plugin-webhook
Section titled “vox-plugin-webhook”Crate: vox-plugin-webhook · Version: 0.6.0 · Target: Library (lib.rs)
Webhook plugin: HTTP listener with HMAC signature verification (GitHub, generic; GitLab deprecated)
Crate Overview
Section titled “Crate Overview”vox-plugin-webhook
Section titled “vox-plugin-webhook”Plugin entry point for the Vox webhook HTTP listener gateway.
Lifecycle (fail closed, D-14)
Section titled “Lifecycle (fail closed, D-14)”Loading the plugin starts nothing: init() only constructs the plugin object.
A listener exists only after the host calls HttpListener::start_listening
with a JSON config carrying a non-blank ingress_token (and optionally addr;
else VOX_WEBHOOK_ADDR, else 0.0.0.0:9080). Without a token the call is
refused and nothing is bound. The listener runs on a tokio runtime owned by
this plugin, binds synchronously so bind errors reach the caller, and
stop_listening (or shutdown) aborts it.
Event routing (D-10)
Section titled “Event routing (D-10)”Accepted events are drained by the host through the WebhookInbox extension
(as_webhook_inbox().poll_events(max)), one JSON-serialized event per item.
D-14: the listener is fail closed and inert until the host starts it.
Workspace Dependencies
Section titled “Workspace Dependencies”| Dependency | Kind |
|---|---|
vox-config | Normal |
vox-http-client | Normal |
vox-plugin-api | Normal |