Skip to content

vox-plugin-webhook API Reference (generated)

Crate: vox-plugin-webhook · Version: 0.6.0 · Target: Library (lib.rs)

Webhook plugin: HTTP listener with HMAC signature verification (GitHub, generic; GitLab deprecated)

Plugin entry point for the Vox webhook HTTP listener gateway.

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.

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.

DependencyKind
vox-configNormal
vox-http-clientNormal
vox-plugin-apiNormal
Dependency Topology, diagram 14 nodes, 3 edges: vox-plugin-webhook → vox-config; vox-plugin-webhook → vox-http-client; vox-plugin-webhook → vox-plugin-apivox-plugin-webhookvox-configvox-http-clientvox-plugin-api
Diagram source
graph {
direction: right
node vox_plugin_webhook: "vox-plugin-webhook"
node vox_config: "vox-config"
vox_plugin_webhook -> vox_config
node vox_http_client: "vox-http-client"
vox_plugin_webhook -> vox_http_client
node vox_plugin_api: "vox-plugin-api"
vox_plugin_webhook -> vox_plugin_api
}