The Handoff step starts chat or SMS message relay. Its editor is titled Agent handoff. For the capability explanation, read Chat and SMS handoff; for a walkthrough, use Set up handoff. Phone transfer uses the separate Call forward step.
Provider and customer fields
| Provider | Step fields | Required routing / identity behavior |
|---|
| Genesys | Integration ID, User email, Customer name, Customer account ID, Queue name, Queue ID; optional Inactivity timeout warning (minutes) | The first six fields must resolve to non-empty values. The warning, when supplied, must be a positive finite number. |
| UJET | Menu ID, Language, User email, User ID | Menu ID chooses the provider menu; the runtime sends it as a number. |
| Kustomer | Title, End user ID, User email, Customer name, Language, Assigned team ID, Brand | Assigned team ID is required by handoff. The connection also needs a webhook signing secret. |
| Dixa | End user ID, User email, Customer name, Language, Queue ID | Queue ID is required. Its connection accepts an optional API domain. |
| Zendesk | End user ID, User email, Customer name, Language, Group ID, Brand ID, Priority | Group identifies a team, not a queue position. Uses Sunshine Conversations and Agent Workspace. |
| Custom Handoff | End user ID, User email, User phone, Customer name, Language, Queue ID | End user ID falls back to the Voiceflow user ID; Language falls back to en. Your service owns queue mapping. |
Handoff context: Full transcript, Custom (a string variable), or None. The editor starts a newly added step with Full transcript; select the intended mode explicitly.
Return path: enable for a connected follow-up or a return to the parent agent. Disable to end the session on return. Failure path: enable and connect the branch taken if creation fails.
Configuration JSON
Use a JSON object in Configuration. Quoted {variable} placeholders support interpolation. A value consisting only of a variable preserves that variable’s type.
| Key | Type / values | Effect and default |
|---|
noteBodyText | string | Kustomer private note. Omitted: no extra note. Other provider-specific delivery is not implied. |
disableFileUpload | boolean | true hides the widget’s customer upload control; omitted leaves normal upload behavior. Human attachments are unaffected. |
waitTimeMessage | None, Delay, Time, Position | None suppresses estimates. Genesys renders Delay; UJET renders Time. Omitted uses provider behavior. Position is accepted by the enum but no provider renders it. |
Invalid JSON or a non-object produces no metadata. A known key with an invalid type is dropped while other valid keys remain. Unknown keys are retained; that does not make them supported Voiceflow settings. Unsupported wait-time modes fall back to provider behavior, so use None to disable an estimate.
"disableFileUpload": "{upload_flag}" needs a boolean variable, not the string "true". Configuration metadata resolves from variables; provider credentials belong in Integrations.
Configuration example
This example adds a Kustomer note and hides customer uploads. It neither generates handoff_summary nor changes the human team’s permissions.