Loading
{ "global": { "icon": "info", "start": "", "end": "" }, "responsive_group_1": { "country": "All", "usertype": "all", "icon": "info", "start": "", "end": "" }, "responsive_group_2": { "country": "All", "usertype": "all", "icon": "info", "start": "", "end": "" } }
[ "filter-cl", "filter-en", "filter-ent" ]

How to configure Upwork Microapps for Citrix Workspace

Set up and manage Upwork Microapps in Citrix Workspace with prerequisites, API setup, service accounts, integration steps, and endpoint behavior.


In this article

What is Citrix Workspace?

Citrix Workspace is an app that allows users to access multiple computers, files, apps, and services from a single unified interface. By adding Upwork to your Citrix Workspace, you can reduce context switching for users and eliminate the need to visit the Upwork platform for many routine tasks.

Citrix Workspace and their integrated microapps provide users with a streamlined work experience and user interface. It works to:

  • Deliver relevant, actionable notifications
  • Offer intuitive microapp workflows
  • Make essential systems and applications directly accessible from a user’s own workspace

The Upwork Microapps for Citrix Workspace can help you save time and effort by giving you direct access to many of Upwork's features right in your company's workspace.

Learn more about Citrix here.

What are the prerequisites for using Upwork Microapps for Citrix Workspace?

These prerequisites assume that the administrator will be a part of the organization's Upwork integration setup. This Upwork admin account must have full read privileges for user information.

Once you set up this integration with Upwork, you'll need these artifacts to add the integration in Citrix Workspace Microapps, specifically the following list of parameters for setting up OAuth integration:

Note that the fields listed will be pre-populated when the template is imported.

Note:

We recommend always using OAuth 2.0 as your service authentication method, when available. OAuth 2.0 ensures your integration meets the maximum security compliance with your configured microapp.

Configure Citrix Gateway to support single sign-on (SSO) for Upwork so that once users have logged in one time, they're automatically logged in again without having to enter their credentials a second time. For more information about configuring SSO, see Citrix Gateway Service.

The integration requires regular access to your Upwork instance, so we require creating a dedicated service account. This account must have the following permissions:

  • Request setup: As an Administrator for your company’s Upwork account, please reach out to your Upwork Solutions Architect for support in setting up your Citrix integration.
  • Permissions Required: Full hiring privileges on all teams

The number of API requests that can be made to specific resources is limited. We recommend Upwork Enterprise plans for use with the Upwork Microapps.

How do I enable APIs and create a service account?

Upwork APIs are enabled by default through web services for paid accounts.

1. Request setup

As an administrator for your company’s Upwork account, please reach out to your Upwork Solutions Architect for support in setting up your Citrix integration.

2. Service account provisioning

To get a Service Account set up (for back-end polling APIs), you’ll need:

  • Client ID
  • Token

The Upwork team will need:

  • Company name
  • User email
  • User ID

3. Service Action Provisioning

To ensure your Upwork Microapps are fully functional, you’ll need to request a client ID & token for end user write actions. 

Apply for your OAuth2 keys here.

Note:

You’ll need to enter the necessary usage and permissions.

  • Project title: Citrix microapp setup
  • Project type: Web project
  • Project description: Citrix microapp service actionsetup
  • API usage: 11–100
  • Auth Type: OAuth 2.0
  • Permissions required: Create, modify and remove job posts

How do I add Upwork Microapps to Citrix Workspace?

To add the Upwork Microapps to Citrix Workspace, the authentication options have been preselected. Ensure that these options are selected as you complete the process.

By applying preselected authentication options, you can use the Upwork Microapps out-of-the-box with pre-configured notifications and actions all ready to use within your Workspace.

  1. Choose the Manage button
    Under My Services, you’ll find the Manage button on the Microapps tile.
  2. Choose Get Started
    You’re now in the Microapps Admin. You’ll see the Get Started button in the middle of the page. You can also choose the Manage tab at the top of the page.
  3. Choose Add Integration
    You’ll see this button once you’re working under the Microapps Admin Manage tab.
  4. Choose Add a new integration from Citrix-provided templates
    You’ll see a popup asking what kind of integration you’d like to add. The first option will be Add a new integration from Citrix-provided templates. Choose this option and select Continue.
  5. Choose Upwork
    The Upwork Microapp tile is white and green, and it displays the Upwork logo.
  6. Choose Add
    Once you choose the Upwork Microapp, a drawer will open showing the integration details. Choose Add to add your configuration details.
  7. Add authorization details
    Input the authorization details to connect your Citrix and Upwork company accounts. Once complete, choose Save.

Note:

There are two sets of tokens, Service Authentication and Service Action. Each has a unique ClientID and Secret requested and received from Upwork.

  1. Enter service authentication details
    1. Within Configuration, look for the Service authentication section
    2. Enter your client ID and client secret in the appropriate fields
    3. Look for the Service Action Authentication section
    4. Enter your client ID and the second client secret in the appropriate fields
    5. Choose Save

Note:

If a user ever wants/needs to change their configuration, you should see the Upwork Microapp listed on the Microapp Integrations page. Open the three-dot menu (...) in the top right corner, and select Edit. Next, select Configuration from the left sidebar to see the full configuration details.

  1. Choose Data loading
    You’ll find the Data loading option in the left sidebar.
  2. Edit GQL_JOB
    You’ll see GQL_JOB listed. Open the (...) menu icon and select Edit.
  3. Set your organization ID
    1. Find the Header tab. 
    2. Set your Organization ID against the parameter X-Upwork-API-TenantId
    3. Once entered, scroll down and choose Apply.
  4. Edit Organization Teams
    1. Return to the Data Loading section. 
    2. This time, go to organization_teams and select Edit.
  5. Return to your Organization ID
    1. Return to the Header tab. 
    2. Set your Organization ID against the parameter X-Upwork-API-TenantId.
    3. Next, find the Body tab and set your Organization ID against the parameter X-Upwork-API-TenantId.
    4. Once entered, scroll down and choose Apply. Your service account is set up and ready to go!

What are the endpoints?

  • List of jobs: Displays the latest active 20 jobs that belong to the organization
  • List of proposals: Displays the latest 10 proposals for each job
  • List of providers: Displays first 100 records with Job Success Score ≥ 90% and English Skill level ≥ 4
  • Ontology Categories: Displays all active categories
  • Organization Team: Displays list of root organization and children which are not hidden
  • Companies: Displays all the companies the currently authorized user has access to
  • Teams: Displays list of teams that belongs to each company

Notes on general behavior

  • Each cache table associated with the endpoints above gets synchronized once every 15 minutes
  • Synchronization happens in full mode

Example: After adding a new job post or canceling a job, the notification should be received in 15 minutes or less.

Was this article helpful?

Upwork Help

Do you need additional help?

Get Support

Log in for personalized service and assistance.