zendesk-messaging-client
    Preparing search index...

    Type Alias SwitchboardPassControl

    SwitchboardPassControl: EventSubSchema & {
        payload?: { conversation?: ConversationTruncated; metadata?: Metadata };
    }

    switchboard:passControl

    Type declaration

    • Optionalpayload?: { conversation?: ConversationTruncated; metadata?: Metadata }

      The payload of the event. The contents of this object depend on the type of event.

      • Optionalconversation?: ConversationTruncated

        The conversation from which the switchboard event was fired. On success, the payload will include an activeSwitchboardIntegration, representing the switchboard integration that is now in control of the conversation.

      • Optionalmetadata?: Metadata