Sets one or more contact event hooks, which are flows associated with contact events, such as customer whisper or agent hold. For more information, see Contact records data model. The following event hooks are valid: + AgentHold + AgentWhisper + CustomerHold + CustomerQueue + CustomerRemaining + CustomerWhisper + DefaultAgentUI + DisconnectAgentUI + PauseContact + ResumeContact
Factories
UpdateContactEventHooks
UpdateContactEventHooks() -> UpdateContactEventHooksHandle
Construct a fresh UpdateContactEventHooks block with an auto-generated id.
Use this when authoring from scratch, the runtime picks a UUID automatically.
UpdateContactEventHooks
UpdateContactEventHooks(id: String) -> UpdateContactEventHooksHandle
Construct a UpdateContactEventHooks block with an operator-supplied id.
| Parameter | Type | Required | Description |
id | String | yes | Wire identifier, typically a Connect UUID restored by decompile so round-trips stay byte-stable. |
Methods
event_hooks
event_hooks(value: Map<String, String>) -> UpdateContactEventHooksHandle
Set the EventHooks parameter. Per-event-hook flow ARN map. Keys are event-hook names (CustomerQueue, CustomerHold, CustomerWhisper, CustomerRemaining, etc.); values are the flow ARNs the hooks route to, or JSONPaths. Measured 2026-10-14: Connect accepts the empty map and a JSONPath value, and refuses a string or an array in place of the map, a key that is not an event hook, and an empty value.
| Parameter | Type | Required | Description |
value | Map<String, String> | yes | Per-event-hook flow ARN map. Keys are event-hook names (CustomerQueue, CustomerHold, CustomerWhisper, CustomerRemaining, etc.); values are the flow ARNs the hooks route to, or JSONPaths. Measured 2026-10-14: Connect accepts the empty map and a JSONPath value, and refuses a string or an array in place of the map, a key that is not an event hook, and an empty value. |
next
next(target: Handle) -> UpdateContactEventHooksHandle
Wire the success-path transition. Substitutes the target's auto-generated UUID into the wire Transitions.NextAction slot.
| Parameter | Type | Required | Description |
target | Handle | yes | The block to route to once this block completes successfully. |
on_no_matching
on_no_matching(target: Handle) -> UpdateContactEventHooksHandle
Wire an error transition for NoMatchingError: if no other Error matches.
| Parameter | Type | Required | Description |
target | Handle | yes | Block to route to on NoMatchingError. if no other Error matches. |
meta_use_dynamic
meta_use_dynamic(value?: bool) -> UpdateContactEventHooksHandle
Set Metadata.ActionMetadata[<id>].useDynamic. Block-level summary toggle — true if any parameter on this block uses a dynamic JSONPath value.
| Parameter | Type | Required | Description |
value | bool | no | Block-level summary toggle — true if any parameter on this block uses a dynamic JSONPath value. |
set_id
set_id(id: String) -> UpdateContactEventHooksHandle
Override the auto-generated identifier with a specific wire id.
| Parameter | Type | Required | Description |
id | String | yes | Wire identifier override. Decompile threads this through to round-trip Connect-side UUIDs. |
meta_position
meta_position(x: i64, y: i64) -> UpdateContactEventHooksHandle
Set the block's canvas position. Mostly auto-emitted by decompile; authored scripts call Flow.auto_layout() instead and let the layout pass fill positions in.
| Parameter | Type | Required | Description |
x | i64 | yes | Canvas X coordinate. |
y | i64 | yes | Canvas Y coordinate. |
set_meta
set_meta(key: String, value: Dynamic) -> UpdateContactEventHooksHandle
Single-key escape hatch, set one ActionMetadata key by name when the typed meta_* setters don't cover it.
| Parameter | Type | Required | Description |
key | String | yes | Wire key name (under Metadata.ActionMetadata[<id>]). |
value | Dynamic | yes | Any JSON-serializable Rhai value. |
overwrite_meta
overwrite_meta(value: Map) -> UpdateContactEventHooksHandle
Full-replace escape hatch, overwrite the entire ActionMetadata blob.
| Parameter | Type | Required | Description |
value | Map | yes | Replacement map for the entire ActionMetadata sub-object. |
set_meta_param
set_meta_param(param: String, flag: String, value: Dynamic) -> UpdateContactEventHooksHandle
Set a single per-parameter ActionMetadata flag.
| Parameter | Type | Required | Description |
param | String | yes | Parameter name (e.g. "Text"). |
flag | String | yes | Flag name ("useDynamic", "MFLAG_*", etc.). |
value | Dynamic | yes | Flag value. |
overwrite_meta_param
overwrite_meta_param(param: String, value: Map) -> UpdateContactEventHooksHandle
Replace the entire flag map for one parameter.
| Parameter | Type | Required | Description |
param | String | yes | Parameter name. |
value | Map | yes | Replacement flag map for the parameter. |
overwrite_parameters
overwrite_parameters(value: Map) -> UpdateContactEventHooksHandle
Wire-shape escape hatch, overwrite the entire Parameters blob.
| Parameter | Type | Required | Description |
value | Map | yes | Replacement parameter map for the block. |
raw_transitions
raw_transitions(value: Map) -> UpdateContactEventHooksHandle
Wire-shape escape hatch for non-canonical transition objects.
| Parameter | Type | Required | Description |
value | Map | yes | Replacement transitions map (raw JSON shape). |