zendesk-messaging-client
    Preparing search index...

    Type Alias PassControlBody

    type PassControlBody = {
        metadata?: Metadata;
        switchboardIntegration: string;
    }
    Index

    Properties

    metadata?: Metadata

    Flat object containing custom properties. Strings, numbers and booleans are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size. The metadata object will be included in the switchboard:passControl webhook.

    switchboardIntegration: string

    The id or the name of the switchboard integration that will become active. May also use the next keyword to transfer control to the next switchboard integration designated in the switchboard hierarchy configuration