SunshineConversationsClient::SwitchboardIntegration

August 27, 2025 ยท View on GitHub

Properties

NameTypeDescriptionNotes
idStringThe unique ID of the switchboard integration.
nameStringIdentifier for use in control transfer protocols. Restricted to alphanumeric characters, `-` and `_`.
integration_idStringId of the integration that should deliver events routed by the switchboard.
integration_typeStringType of integration that should deliver events routed by the switchboard. If referencing an OAuth integration, the clientId issued by Sunshine Conversations during the OAuth partnership process will be the value of integrationType.
deliver_standby_eventsBooleanSetting to determine if webhooks should be sent when the switchboard integration is not in control of a conversation (standby status)
next_switchboard_integration_idStringThe switchboard integration id to which control of a conversation is passed / offered by default.[optional]
message_history_countIntegerNumber of messages to include in the message history context.[optional]

Example

require 'sunshine-conversations-client'

instance = SunshineConversationsClient::SwitchboardIntegration.new(
  id: 5ef21b86e933b7355c11c604,
  name: bot,
  integration_id: 5ef21b86e933b7355c11c605,
  integration_type: zd:agentWorkspace,
  deliver_standby_events: null,
  next_switchboard_integration_id: 5ef21b86e933b7355c11c606,
  message_history_count: 5
)