StyloDocs
Workflow blocks

Get Conversation

Fetch a Sunshine Conversations conversation, including current switchboard control.

View as Markdown

zendesk/get-conversation — Fetch a Sunshine Conversations conversation, including current switchboard control.

Where it appears

The Get Conversation 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 to fetch, including its current switchboard control. Use a literal ID or <StepName.field>.

Inputs and outputs

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

Outputs

Reference an output downstream with <Get Conversation.field>.

NameTypeDescription
successbooleanSuccess status
conversationjsonConversation object (object — fields: id, type, activeSwitchboardIntegration)
errorstringError message if failed

Example

A minimal configuration for this block:

{
  "type": "zendesk/get-conversation",
  "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