Struct ElicitationHook 

pub struct ElicitationHook;

Elicitation hook — drives a human-in-the-loop step through a channel plugin (Keycloak CIBA, Slack, in-band, …).

Payload (ElicitationPayload) — unified input + accumulator. The apl-cpex bridge sets the input fields (operation, elicitation_id, kind, from, purpose, scope, timeout, channel) and invokes the hook; the handler populates the output fields (id, status, outcome, approver, intent_id, expires_at, valid, reason) on a clone of the running payload and returns it via PluginResult::modify_payload. Input fields are private and read through accessors.

Result (PluginResult<ElicitationPayload>) — the executor’s standard envelope. modified_payload carries the updated payload. continue_processing = false halts (the handler could not service the operation — e.g. unknown channel error); the bridge maps that to an ElicitationError.

Three operations, one hook. ElicitationPayload::operation tells the handler whether this is a Dispatch, Check, or Validate call. A handler typically matches on it. The three short, synchronous calls span the (possibly hours-long) human gap, which is owned by the channel — never by a handler call.

Handler signature:

impl HookHandler<ElicitationHook> for CibaApprover {
    async fn handle(
        &self,
        payload: &ElicitationPayload,
        _ext: &Extensions,
        _ctx: &mut PluginContext,
    ) -> PluginResult<ElicitationPayload> {
        let mut out = payload.clone();
        match payload.operation() {
            ElicitationOp::Dispatch => { /* register intent + CIBA backchannel */ }
            ElicitationOp::Check    => { /* poll Keycloak token endpoint */ }
            ElicitationOp::Validate => { /* verify token + intent binding */ }
        }
        PluginResult::modify_payload(out)
    }
}

Registration: manager.register_handler_for_names::<ElicitationHook, _>(plugin, config, &["elicit"]).

Trait Implementations

impl HookTypeDef for ElicitationHook

const NAME: &'static str = "elicit"

Hook name — used as the registry key and in config YAML.

type Payload = ElicitationPayload

The typed payload that handlers receive. Must implement PluginPayload (Clone + Send + Sync + ’static).

type Result = PluginResult<ElicitationPayload>

The typed result that handlers return.