> ## Documentation Index > Fetch the complete documentation index at: https://iii.dev/docs/llms.txt > Use this file to discover all available pages before exploring further. # Helpers (Rust) > API reference for the iii-helpers crate (Rust). {/* AI: any skill-check (vale/AI) text fixes belong in the source doc-comments under sdk/packages/rust/helpers/src (prose) or docs/next/scripts/ (structure/formatting), then regenerate. Never edit this file directly. */} ## Installation ```bash theme={"theme":{"light":"catppuccin-latte","dark":"dark-plus"}} cargo add iii-helpers ``` API reference for the iii-helpers crate (Rust). ## http HTTP request/response types, auth config, and the `http` helper. **Import** ```rust theme={"theme":{"light":"catppuccin-latte","dark":"dark-plus"}} use iii_helpers::http; ``` ### Types [`HttpAuthConfig`](#httpauthconfig) · [`HttpInvocationConfig`](#httpinvocationconfig) · [`HttpMethod`](#httpmethod) · [`HttpRequest`](#httprequest) · [`HttpResponse`](#httpresponse) ### HttpAuthConfig Authentication configuration for HTTP-invoked functions. * `Hmac`: HMAC signature verification using a shared secret. * `Bearer`: Bearer token authentication. * `ApiKey`: API key sent via a custom header. | Name | Type | Required | Description | | -------- | --------------------------------------- | -------- | ----------- | | `Hmac` | `{ secret_key: String }` | Yes | - | | `Bearer` | `{ token_key: String }` | Yes | - | | `ApiKey` | `{ header: String, value_key: String }` | Yes | - | *** ### HttpInvocationConfig Configuration for an HTTP-invoked function (Lambda, Cloudflare Workers, etc.). | Name | Type | Required | Description | | ------------ | -------------------------------------------- | -------- | ---------------------------------------- | | `url` | `String` | Yes | URL to invoke. | | `method` | [`HttpMethod`](#httpmethod) | Yes | HTTP method. Defaults to `POST`. | | `timeout_ms` | `Option` | No | Timeout in milliseconds. | | `headers` | `HashMap` | Yes | Custom headers to send with the request. | | `auth` | Option\<[`HttpAuthConfig`](#httpauthconfig)> | No | Authentication configuration. | *** ### HttpMethod HTTP method accepted by `HttpInvocationConfig`. Distinct from the core `builtin_triggers` HTTP method enum, which also covers HEAD/OPTIONS. | Name | Type | Required | Description | | -------- | ------ | -------- | ----------- | | `Get` | `unit` | Yes | - | | `Post` | `unit` | Yes | - | | `Put` | `unit` | Yes | - | | `Patch` | `unit` | Yes | - | | `Delete` | `unit` | Yes | - | *** ### HttpRequest Buffered HTTP request received by a function handler. | Name | Type | Required | Description | | -------------- | ------------------------- | -------- | ------------------------------------------------- | | `query_params` | `HashMap` | Yes | Query-string parameters from the request URL. | | `path_params` | `HashMap` | Yes | Path parameters extracted from the matched route. | | `headers` | `HashMap` | Yes | Request headers. | | `path` | `String` | Yes | Request path. | | `method` | `String` | Yes | HTTP method of the request (e.g. `GET`, `POST`). | | `body` | `T` | Yes | Parsed request body. | *** ### HttpResponse Buffered HTTP response returned from a function handler. | Name | Type | Required | Description | | ------------- | ------------------------- | -------- | ----------------- | | `status_code` | `u16` | Yes | HTTP status code. | | `headers` | `HashMap` | Yes | Response headers. | | `body` | `T` | Yes | Response body. | ## observability Logger, OpenTelemetry config, and span helpers. **Import** ```rust theme={"theme":{"light":"catppuccin-latte","dark":"dark-plus"}} use iii_helpers::observability; ``` ### Types [`BaggageSpanProcessor`](#baggagespanprocessor) · [`ConnectionState`](#connectionstate) · [`Logger`](#logger) · [`OtelConfig`](#otelconfig) · [`ReconnectionConfig`](#reconnectionconfig) · [`WorkerGaugesOptions`](#workergaugesoptions) ### BaggageSpanProcessor OpenTelemetry span processor that copies OTel baggage entries onto each started span as attributes. | Name | Type | Required | Description | | ----- | -------------- | -------- | ----------- | | `new` | `fn() -> Self` | Yes | - | *** ### ConnectionState Connection state for the shared WebSocket | Name | Type | Required | Description | | -------------- | ------ | -------- | ----------- | | `Disconnected` | `unit` | Yes | - | | `Connecting` | `unit` | Yes | - | | `Connected` | `unit` | Yes | - | | `Reconnecting` | `unit` | Yes | - | | `Failed` | `unit` | Yes | - | *** ### Logger Structured logger that emits logs as OpenTelemetry LogRecords. Every log call automatically captures the active trace and span context, correlating your logs with distributed traces without any manual wiring. When OTel is not initialized, Logger gracefully falls back to the `tracing` crate. Pass structured data as the second argument to any log method. Using a `serde_json::Value` object of key-value pairs (instead of string interpolation) lets you filter, aggregate, and build dashboards in your observability backend. | Name | Type | Required | Description | | ------- | ---------------------------------------- | -------- | ----------------------------- | | `debug` | `fn(message: &str, data: Option)` | Yes | Log a debug-level message. | | `error` | `fn(message: &str, data: Option)` | Yes | Log an error-level message. | | `info` | `fn(message: &str, data: Option)` | Yes | Log an info-level message. | | `new` | `fn() -> Self` | Yes | Create a new Logger instance. | | `warn` | `fn(message: &str, data: Option)` | Yes | Log a warning-level message. | *** ### OtelConfig Configuration for OpenTelemetry initialization | Name | Type | Required | Description | | ------------------------------- | ---------------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `enabled` | `Option` | No | Whether OpenTelemetry export is enabled. Defaults to true. Set to false or `OTEL_ENABLED=false/0/no/off` to disable. | | `service_name` | `Option` | No | The service name to report. Defaults to the `OTEL_SERVICE_NAME` env var. | | `service_version` | `Option` | No | The service version to report. Defaults to the `SERVICE_VERSION` env var or "unknown". | | `service_namespace` | `Option` | No | The service namespace to report. Defaults to the `SERVICE_NAMESPACE` env var. | | `service_instance_id` | `Option` | No | The service instance ID to report. Defaults to the `SERVICE_INSTANCE_ID` env var or an auto-generated UUID. | | `engine_ws_url` | `Option` | No | III Engine WebSocket URL. Defaults to the `III_URL` env var or "ws\://localhost:49134". | | `metrics_enabled` | `Option` | No | Whether metrics export is enabled. Defaults to true. Set to false or `OTEL_METRICS_ENABLED=false/0/no/off` to disable. | | `metrics_export_interval_ms` | `Option` | No | Metrics export interval in milliseconds. Defaults to 60000 (60 seconds). | | `reconnection_config` | Option\<[`ReconnectionConfig`](#reconnectionconfig)> | No | Optional reconnection configuration for the WebSocket connection. | | `shutdown_timeout_ms` | `Option` | No | Timeout in milliseconds for the shutdown sequence (default: 10,000) | | `channel_capacity` | `Option` | No | Capacity of the internal telemetry message channel (default: 10,000).
This controls the in-flight message buffer between exporters and the
WebSocket connection loop. Intentionally larger than
`ReconnectionConfig::max_pending_messages` to absorb bursts during
normal operation while limiting stale data across reconnects. | | `spans_flush_interval_ms` | `Option` | No | Span processor flush delay in milliseconds. Defaults to 100ms when not
set. The OpenTelemetry default of 5000ms is what makes traces appear
seconds after the action. Env override: OTEL\_SPANS\_FLUSH\_INTERVAL\_MS. | | `logs_enabled` | `Option` | No | Whether to enable the log exporter (default: true) | | `logs_flush_interval_ms` | `Option` | No | Log processor flush delay in milliseconds. Defaults to 100ms when not set. | | `logs_batch_size` | `Option` | No | Maximum number of log records exported per batch. Defaults to 1 when not set. | | `fetch_instrumentation_enabled` | `Option` | No | Whether to auto-instrument outgoing HTTP calls.
When `Some(true)` (default), `execute_traced_request()` can be used to
create CLIENT spans for reqwest requests. Set `Some(false)` to opt out.
`None` is treated as `true`. | | `live_spans` | `Option` | No | Announce span STARTS to the engine as zero-end OTLP snapshots so live
trace views render in-progress work (`LiveSpanStartProcessor`). One
extra frame per span; the engine stores it as `pending` (or drops it
when its live-span storage is off) and the final span replaces it in
place. Default: enabled. Env override: `OTEL_LIVE_SPANS`, the same
switch the engine uses for its own start mirroring. | *** ### ReconnectionConfig Configuration for WebSocket reconnection behavior | Name | Type | Required | Description | | ---------------------------- | ------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `initial_delay_ms` | `u64` | Yes | Starting delay in milliseconds (default: 1000). | | `max_delay_ms` | `u64` | Yes | Maximum delay cap in milliseconds (default: 30000). | | `backoff_multiplier` | `f64` | Yes | Exponential backoff multiplier (default: 2). | | `jitter_factor` | `f64` | Yes | Random jitter factor, 0-1 (default: 0.3). | | `max_retries` | `Option` | No | Maximum retry attempts; `None` for infinite (default: `None`). | | `max_pending_messages` | `usize` | Yes | Maximum messages preserved across reconnects. Messages beyond this limit
are dropped to prevent delivering stale data after a long disconnect.
This is intentionally smaller than `OtelConfig::channel_capacity` (the
in-flight buffer between exporters and the WebSocket loop). | | `effective_initial_delay_ms` | `fn() -> u64` | Yes | Returns initial\_delay\_ms, clamped to a minimum of 1ms to prevent division by zero. | *** ### WorkerGaugesOptions Options for registering worker gauges. | Name | Type | Required | Description | | ------------- | ---------------- | -------- | ------------------------------------------------------------ | | `worker_id` | `String` | Yes | Stable identifier of the worker the gauges are reported for. | | `worker_name` | `Option` | No | Human-readable name of the worker. | ## queue Queue enqueue result types. **Import** ```rust theme={"theme":{"light":"catppuccin-latte","dark":"dark-plus"}} use iii_helpers::queue; ``` ### Types [`EnqueueResult`](#enqueueresult) ### EnqueueResult Result returned when a function is invoked with `TriggerAction.Enqueue`. | Name | Type | Required | Description | | -------------------- | -------- | -------- | ------------------------------------------- | | `message_receipt_id` | `String` | Yes | Unique receipt ID for the enqueued message. | ## stream Stream trigger configs, change events, IO inputs, and update operations. **Import** ```rust theme={"theme":{"light":"catppuccin-latte","dark":"dark-plus"}} use iii_helpers::stream; ``` ### Types [`MergePath`](#mergepath) · [`StreamAuthInput`](#streamauthinput) · [`StreamAuthResult`](#streamauthresult) · [`StreamChangeEvent`](#streamchangeevent) · [`StreamChangeEventDetail`](#streamchangeeventdetail) · [`StreamDeleteInput`](#streamdeleteinput) · [`StreamDeleteResult`](#streamdeleteresult) · [`StreamEventType`](#streameventtype) · [`StreamGetInput`](#streamgetinput) · [`StreamJoinLeaveEvent`](#streamjoinleaveevent) · [`StreamJoinLeaveTriggerConfig`](#streamjoinleavetriggerconfig) · [`StreamJoinResult`](#streamjoinresult) · [`StreamListGroupsInput`](#streamlistgroupsinput) · [`StreamListInput`](#streamlistinput) · [`StreamSetInput`](#streamsetinput) · [`StreamSetResult`](#streamsetresult) · [`StreamTriggerConfig`](#streamtriggerconfig) · [`StreamUpdateInput`](#streamupdateinput) · [`StreamUpdateResult`](#streamupdateresult) · [`UpdateOp`](#updateop) · [`UpdateOpError`](#updateoperror) ### MergePath Path target for a `UpdateOp::Merge` operation. Accepts either a single string (legacy / first-level field) or an array of literal segments (nested path). Path normalization rules applied by the engine: * absent / `Single("")` / `Segments(vec![])` → root merge * `Single("foo")` is equivalent to `Segments(vec!["foo".into()])` * `Segments(["a", "b", "c"])` walks three literal keys, never interpreting dots specially. `Segments(vec!["a.b".into()])` is a single literal key named `"a.b"`. **Variant ordering is load-bearing.** `#[serde(untagged)]` tries variants in declaration order, `Single` MUST come before `Segments` so a JSON string deserializes into `Single` rather than failing the array match first. | Name | Type | Required | Description | | ---------- | --------------- | -------- | ----------- | | `Single` | `(String)` | Yes | - | | `Segments` | `(Vec)` | Yes | - | *** ### StreamAuthInput Input for stream authentication. | Name | Type | Required | Description | | -------------- | ------------------------------ | -------- | ----------------- | | `headers` | `HashMap` | Yes | Request headers. | | `path` | `String` | Yes | Request path. | | `query_params` | `HashMap>` | Yes | Query parameters. | | `addr` | `String` | Yes | Client address. | *** ### StreamAuthResult Result of stream authentication. | Name | Type | Required | Description | | --------- | --------------- | -------- | ----------------------------------------------------------------- | | `context` | `Option` | No | Arbitrary context passed to stream handlers after authentication. | *** ### StreamChangeEvent Handler input for `stream` triggers, fired when an item changes via `stream::set`, `stream::update`, or `stream::delete`. | Name | Type | Required | Description | | ------------- | ----------------------------------------------------- | -------- | --------------------------------------------------- | | `event_type` | `String` | Yes | Always `"stream"`. | | `timestamp` | `i64` | Yes | Unix timestamp (milliseconds) of the event. | | `stream_name` | `String` | Yes | The stream where the change occurred. | | `group_id` | `String` | Yes | The group where the change occurred. | | `id` | `Option` | No | The item ID that changed. | | `event` | [`StreamChangeEventDetail`](#streamchangeeventdetail) | Yes | The event detail containing mutation type and data. | *** ### StreamChangeEventDetail Detail of a stream change event containing the mutation type and data. | Name | Type | Required | Description | | ------------ | ------------------------------------- | -------- | ------------------------------------------------- | | `event_type` | [`StreamEventType`](#streameventtype) | Yes | The kind of mutation (create, update, or delete). | | `data` | `Value` | Yes | The data associated with the event. | *** ### StreamDeleteInput Input for deleting a stream item. | Name | Type | Required | Description | | ------------- | -------- | -------- | ------------------- | | `stream_name` | `String` | Yes | Name of the stream. | | `group_id` | `String` | Yes | Group identifier. | | `item_id` | `String` | Yes | Item identifier. | *** ### StreamDeleteResult Result of a stream delete operation. | Name | Type | Required | Description | | ----------- | --------------- | -------- | ------------------------------- | | `old_value` | `Option` | No | Previous value (if it existed). | *** ### StreamEventType The kind of mutation that occurred on a stream item. | Name | Type | Required | Description | | -------- | ------ | -------- | ----------- | | `Create` | `unit` | Yes | - | | `Update` | `unit` | Yes | - | | `Delete` | `unit` | Yes | - | *** ### StreamGetInput Input for retrieving a single stream item. | Name | Type | Required | Description | | ------------- | -------- | -------- | ------------------- | | `stream_name` | `String` | Yes | Name of the stream. | | `group_id` | `String` | Yes | Group identifier. | | `item_id` | `String` | Yes | Item identifier. | *** ### StreamJoinLeaveEvent Event payload for stream join/leave triggers. | Name | Type | Required | Description | | ----------------- | ---------------- | -------- | ------------------------------------- | | `subscription_id` | `String` | Yes | Unique subscription identifier. | | `stream_name` | `String` | Yes | Name of the stream. | | `group_id` | `String` | Yes | Group identifier. | | `id` | `Option` | No | Item identifier (if applicable). | | `context` | `Option` | No | Auth context from `StreamAuthResult`. | *** ### StreamJoinLeaveTriggerConfig Trigger config for `stream:join` and `stream:leave` triggers. | Name | Type | Required | Description | | ----------------------- | ---------------- | -------- | -------------------------------------------------------- | | `stream_name` | `Option` | No | Stream name to watch | | `condition_function_id` | `Option` | No | Optional function ID to evaluate before invoking handler | *** ### StreamJoinResult Result of a stream join request. | Name | Type | Required | Description | | -------------- | ------ | -------- | ---------------------------------- | | `unauthorized` | `bool` | Yes | Whether the join was unauthorized. | *** ### StreamListGroupsInput Input for listing all groups in a stream. | Name | Type | Required | Description | | ------------- | -------- | -------- | ------------------- | | `stream_name` | `String` | Yes | Name of the stream. | *** ### StreamListInput Input for listing all items in a stream group. | Name | Type | Required | Description | | ------------- | -------- | -------- | ------------------- | | `stream_name` | `String` | Yes | Name of the stream. | | `group_id` | `String` | Yes | Group identifier. | *** ### StreamSetInput Input for setting a stream item. | Name | Type | Required | Description | | ------------- | -------- | -------- | ------------------- | | `stream_name` | `String` | Yes | Name of the stream. | | `group_id` | `String` | Yes | Group identifier. | | `item_id` | `String` | Yes | Item identifier. | | `data` | `Value` | Yes | Data to store. | *** ### StreamSetResult Result of a stream set operation. | Name | Type | Required | Description | | ----------- | --------------- | -------- | ------------------------------- | | `old_value` | `Option` | No | Previous value (if it existed). | | `new_value` | `Value` | Yes | The value after the update | *** ### StreamTriggerConfig Trigger config for `stream` triggers. Filters which item changes fire the handler. | Name | Type | Required | Description | | ----------------------- | ---------------- | -------- | -------------------------------------------------------- | | `stream_name` | `Option` | No | Stream name to watch | | `group_id` | `Option` | No | Group ID filter | | `item_id` | `Option` | No | Item ID filter | | `condition_function_id` | `Option` | No | Optional function ID to evaluate before invoking handler | *** ### StreamUpdateInput Input for atomically updating a stream item. | Name | Type | Required | Description | | ------------- | ----------------------------- | -------- | ------------------------------------------------------ | | `stream_name` | `String` | Yes | Name of the stream. | | `group_id` | `String` | Yes | Group identifier. | | `item_id` | `String` | Yes | Item identifier. | | `ops` | Vec\<[`UpdateOp`](#updateop)> | Yes | Ordered list of update operations to apply atomically. | *** ### StreamUpdateResult Result of an atomic update operation | Name | Type | Required | Description | | ----------- | --------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `old_value` | `Option` | No | Previous value (if it existed). | | `new_value` | `Value` | Yes | The value after the update | | `errors` | Vec\<[`UpdateOpError`](#updateoperror)> | Yes | Errors encountered while applying ops. Successfully applied ops
are still reflected in `new_value`. Field is omitted from JSON
when empty for backward compatibility. | *** ### UpdateOp Operations that can be performed atomically on a stream value | Name | Type | Required | Description | | ----------- | ----------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Set` | `{ path: String, value: Option }` | Yes | Set a value at path (overwrite) | | `Merge` | \{ path: Option\<[`MergePath`](#mergepath)>, value: Value } | Yes | Merge object into existing value (object-only). Path may be
omitted (root merge), a single first-level key, or an array of
literal segments for nested merge. See `MergePath`. | | `Increment` | `{ path: String, by: i64 }` | Yes | Increment numeric value | | `Decrement` | `{ path: String, by: i64 }` | Yes | Decrement numeric value | | `Append` | \{ path: Option\<[`MergePath`](#mergepath)>, value: Value } | Yes | Append an element to an array or concatenate a string at the
optional path. Path may be omitted (root append), a single
first-level key, or an array of literal segments for nested
append. See `MergePath` for the variant shape. | | `Remove` | `{ path: String }` | Yes | Remove a field | *** ### UpdateOpError Per-op error reported by an atomic update operation. | Name | Type | Required | Description | | ---------- | ---------------- | -------- | ----------------------------------------------------------------- | | `op_index` | `usize` | Yes | Index of the offending op within the original `ops` array. | | `code` | `String` | Yes | Stable error code, e.g. `"merge.path.too_deep"`. | | `message` | `String` | Yes | Human-readable description with concrete numbers when applicable. | | `doc_url` | `Option` | No | Optional documentation URL for this error class. | ## worker\_connection\_manager RBAC auth and registration callback types. **Import** ```rust theme={"theme":{"light":"catppuccin-latte","dark":"dark-plus"}} use iii_helpers::worker_connection_manager; ``` ### Types [`AuthInput`](#authinput) · [`AuthResult`](#authresult) · [`OnFunctionRegistrationInput`](#onfunctionregistrationinput) · [`OnFunctionRegistrationResult`](#onfunctionregistrationresult) · [`OnTriggerRegistrationInput`](#ontriggerregistrationinput) · [`OnTriggerRegistrationResult`](#ontriggerregistrationresult) · [`OnTriggerTypeRegistrationInput`](#ontriggertyperegistrationinput) · [`OnTriggerTypeRegistrationResult`](#ontriggertyperegistrationresult) ### AuthInput Input passed to the RBAC auth function during WebSocket upgrade. Contains the HTTP headers, query parameters, and client IP from the connecting worker's upgrade request. | Name | Type | Required | Description | | -------------- | ------------------------------ | -------- | ------------------------------------------------------------------------------------------------------------------------ | | `headers` | `HashMap` | Yes | HTTP headers from the WebSocket upgrade request. | | `query_params` | `HashMap>` | Yes | Query parameters from the upgrade URL. Each key maps to a vec of values
to support repeated keys (e.g. `?a=1&a=2`). | | `ip_address` | `String` | Yes | IP address of the connecting client. | *** ### AuthResult Return value from the RBAC auth function. Controls which functions the authenticated worker can invoke and what context is forwarded to the middleware. | Name | Type | Required | Description | | --------------------------------- | --------------------- | -------- | ----------------------------------------------------------------------------------------------- | | `allowed_functions` | `Vec` | Yes | Additional function IDs to allow beyond the `expose_functions` config. | | `forbidden_functions` | `Vec` | Yes | Function IDs to deny even if they match `expose_functions`.
Takes precedence over allowed. | | `allowed_trigger_types` | `Option>` | No | Trigger type IDs the worker may register triggers for.
When `None`, all types are allowed. | | `allow_trigger_type_registration` | `bool` | Yes | Whether the worker may register new trigger types. Defaults to `false`. | | `allow_function_registration` | `bool` | Yes | Whether the worker may register new functions. Defaults to `true`. | | `context` | `Value` | Yes | Arbitrary context forwarded to the middleware function on every
invocation. | | `function_registration_prefix` | `Option` | No | Optional prefix applied to all function IDs registered by this worker. | *** ### OnFunctionRegistrationInput Input passed to the `on_function_registration_function_id` hook when a worker attempts to register a function through the RBAC port. Return an `OnFunctionRegistrationResult` with the (possibly mapped) fields, or return an error to deny the registration. | Name | Type | Required | Description | | ------------- | ---------------- | -------- | -------------------------------------------------------- | | `function_id` | `String` | Yes | ID of the function being registered. | | `description` | `Option` | No | Human-readable description of the function. | | `metadata` | `Option` | No | Arbitrary metadata attached to the function. | | `context` | `Value` | Yes | Auth context from `AuthResult.context` for this session. | *** ### OnFunctionRegistrationResult Result returned from the `on_function_registration_function_id` hook. Omitted fields keep the original value from the registration request. | Name | Type | Required | Description | | ------------- | ---------------- | -------- | ------------------- | | `function_id` | `Option` | No | Mapped function ID. | | `description` | `Option` | No | Mapped description. | | `metadata` | `Option` | No | Mapped metadata. | *** ### OnTriggerRegistrationInput Input passed to the `on_trigger_registration_function_id` hook when a worker attempts to register a trigger through the RBAC port. Return an `OnTriggerRegistrationResult` with the (possibly mapped) fields, or return an error to deny the registration. | Name | Type | Required | Description | | -------------- | --------------- | -------- | -------------------------------------------------------- | | `trigger_id` | `String` | Yes | ID of the trigger being registered. | | `trigger_type` | `String` | Yes | Trigger type identifier. | | `function_id` | `String` | Yes | ID of the function this trigger is bound to. | | `config` | `Value` | Yes | Trigger-specific configuration. | | `metadata` | `Option` | No | Arbitrary metadata attached to the trigger. | | `context` | `Value` | Yes | Auth context from `AuthResult.context` for this session. | *** ### OnTriggerRegistrationResult Result returned from the `on_trigger_registration_function_id` hook. Omitted fields keep the original value from the registration request. | Name | Type | Required | Description | | -------------- | ---------------- | -------- | ----------------------------- | | `trigger_id` | `Option` | No | Mapped trigger ID. | | `trigger_type` | `Option` | No | Mapped trigger type. | | `function_id` | `Option` | No | Mapped function ID. | | `config` | `Option` | No | Mapped trigger configuration. | *** ### OnTriggerTypeRegistrationInput Input passed to the `on_trigger_type_registration_function_id` hook when a worker attempts to register a new trigger type through the RBAC port. Return an `OnTriggerTypeRegistrationResult` with the (possibly mapped) fields, or return an error to deny the registration. | Name | Type | Required | Description | | ----------------- | -------- | -------- | -------------------------------------------------------- | | `trigger_type_id` | `String` | Yes | ID of the trigger type being registered. | | `description` | `String` | Yes | Human-readable description of the trigger type. | | `context` | `Value` | Yes | Auth context from `AuthResult.context` for this session. | *** ### OnTriggerTypeRegistrationResult Result returned from the `on_trigger_type_registration_function_id` hook. Omitted fields keep the original value from the registration request. | Name | Type | Required | Description | | ----------------- | ---------------- | -------- | ----------------------- | | `trigger_type_id` | `Option` | No | Mapped trigger type ID. | | `description` | `Option` | No | Mapped description. |