Source Events ↗

plugins.route_invoked

A plugin route handled a request.

When
After a route.register handler returns ROUTE_OK.
Payload
JSON: { plugin, method, path, status }.
Cancelable
No

Plugin routes use the same bearer auth as /api/system.

Use cases

  • Plugin route metrics
  • Auditing custom APIs

Example

Registration and handler

Register

hook!(host, PluginEvent::PluginRouteInvoked, on_route_invoked);

Handler

extern "C" fn on_event(ctx: *const EventContext) -> HookResult {
    let ctx = unsafe { &*ctx };
    let payload = unsafe { std::slice::from_raw_parts(ctx.payload_ptr, ctx.payload_len) };
    let _json = std::str::from_utf8(payload).unwrap_or_default();
    HookResult::r#continue()
}

← All lifecycle events