Workflow blocks
Get Conversation
Fetch a Sunshine Conversations conversation, including current switchboard control.
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
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
conversationId | text (supports references) | Yes | — | Sunshine 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>.
| Name | Type | Description |
|---|---|---|
success | boolean | Success status |
conversation | json | Conversation object (object — fields: id, type, activeSwitchboardIntegration) |
error | string | Error 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
erroroutput is populated; downstream blocks that reference other outputs may not receive values.