StyloDocs
Workflow blocks

Pass Conversation Control

Pass switchboard control to another integration (e.g. escalate to a human agent).

View as Markdown

zendesk/pass-conversation-control — Pass switchboard control to another integration (e.g. escalate to a human agent).

Where it appears

The Pass Conversation Control block lives in the Integrations group of the Workflow Builder. Connect the Zendesk integration before adding it.

Fields

FieldTypeRequiredDefaultDescription
conversationIdtext (supports references)YesSunshine Conversations conversation ID whose switchboard control should be passed. Use a literal ID or <StepName.field>.
metadatacodeNoOptional metadata to attach to the passControl event.

Inputs and outputs

Inputs are the configurable fields above. The block produces these outputs:

Outputs

Reference an output downstream with <Pass Conversation Control.field>.

NameTypeDescription
successbooleanSuccess status
errorstringError message if failed

Example

A minimal configuration for this block:

{
  "type": "zendesk/pass-conversation-control",
  "config": {
    "conversationId": "<PreviousStep.field>"
  }
}

Limits and failure modes

  • Requires a connected Zendesk integration. Calls fail if that integration is disconnected or its authorization has expired.
  • Required field (conversationId) must be set, or the block fails validation before it runs.
  • On failure the error output is populated; downstream blocks that reference other outputs may not receive values.

On this page