StyloDocs
Workflow blocks

Conversation Message

Trigger workflow when a customer sends a new message on a Zendesk messaging channel (Sunshine Conversations).

View as Markdown

trigger/conversation-message — Trigger workflow when a customer sends a new message on a Zendesk messaging channel (Sunshine Conversations).

Where it appears

The Conversation Message block is a trigger — it starts a workflow. Add it from the Triggers group in the Workflow Builder.

Fields

FieldTypeRequiredDefaultDescription
channelsmulti-selectNoLimit to specific messaging channels. Leave all unchecked to fire on any channel. Options: whatsapp, messenger, instagram, web, ios, android, twitter, line, viber, telegram, wechat, kakao, sms, googlebusinessmessages, applebusinesschat.
brandIdslistNoLimit to conversations on specific Zendesk brands. Leave empty to fire on any brand.
firstMessageOnlytoggleNofalseFire only on the first inbound message on a conversation (e.g. for auto-greet workflows).
testInputcodeNoSample message-event JSON to use when running this workflow in test mode instead of waiting for a real inbound conversation message.

Inputs and outputs

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

Outputs

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

NameTypeDescription
triggeredbooleanWhether the trigger fired
timestampnumberTrigger timestamp (epoch ms)
conversationIdstringSunshine Conversations conversation ID
ticketIdstringZendesk ticket ID resolved from the conversation
messageIdstringSC message ID
messageTextstringMessage text body
messageTimestampstringISO 8601 timestamp of the message
authorUserIdstringSC user ID of the message author
channelstringSC channel type (e.g. whatsapp, web, messenger)
brandIdstringZendesk brand ID, if available
subdomainstringZendesk subdomain
webhookEventIdstringDeduplication ID for the originating webhook event

Example

A minimal configuration for this block:

{
  "type": "trigger/conversation-message",
  "config": {
    "firstMessageOnly": false
  }
}

On this page