Get started

Building a server-side example using Nmake

Examples of the latest server-side executables are available for testing. You can download the latest Windows Virtual Channel SDK to develop the server-side component.

Building a client-side example

To build an example, you need to configure the virtual channels, and host the third-party code on the webserver as follows:

  • Step 1 - Configuring the Citrix Workspace app.
  • Step 2 - Loading a sample virtual channel app.
  • Step 3 - Running an example virtual channel.

Go to the downloads page to view examples and a detailed guide on configuring the sample.

Step 1 - Configuring the Citrix Workspace app

Use one of the following configuration methods:

  • Configuration.js
  • Global App Config service

Step 2 - Loading a sample virtual channel app

The sample apps illustrate a third-party implementation of the Virtual Channel SDK. You can make the virtual channel resources available for the Citrix Workspace app by the following two-step process.

Hosting third-party code on the webserver

Citrix also provides sample third-party code for each example virtual channel that can be hosted on a webserver. The following steps illustrate how to host the file on a local server:

  • Download and extract the HTML5 sample (CitrixWorkspaceAppChromeVCSDK_XX.X.X.X_Examples > html5Sample) to the folder html5Sample.
  • Copy the folder html5Sample onto your webserver and host it with the ‘https’ protocol.
  • Open the Google Chrome browser and enter the webserver URL https://<webserverurl>/Thirdparty.html.
  • Verify if the webserver URL is accessible through the browser.
  • Configure the webserver URL through Citrix Workspace app.


All third-party implementations of the Virtual Channel SDK should implement the window.onmessage event listener, and should validate the origin of the event and then pass the event to citrix.receiver.onMessage.

window.onmessage = (event) => {
    if(event.origin == "" && // check for trustworthy URL ==="CITRIX" && === "VCSDK"){

Step 3 - Running an example virtual channel

Verify the following:

  • Custom VC configurations are properly maintained in the Citrix Workspace app.
  • Third-party resources are available.

Start the session using Citrix Workspace app for HTML5 and run the server-side executable after the above steps are completed.

Get started