Integrate Yeastar P-Series Software Edition with Zendesk

This topic describes how to integrate Yeastar P-Series Software Edition with Zendesk.


  • Zendesk Suite: Suite Team, Suite Growth, Suite Professional, Suite Enterprise
  • Zendesk Support only: Support Team, Support Professional, Support Enterprise
PBX server
  • Plan: Enterprise Plan (EP) or Ultimate Plan (UP)
  • Firmware: Version or later



Step 1. Get authentication information from PBX

  1. Log in to PBX web portal, go to Integrations > Helpdesk.
  2. On the right side of Zendesk, click Integrate.

  3. In the Network section, click to note down the redirect URL, as you will use it when registering an application with Zendesk.

Step 2. Register an application with Zendesk

  1. Log in to your Zendesk account.
  2. On the top-right corner, click , then click Admin Center.

  3. On the left navigation bar, go to Apps and integrations > APIs > Zendesk API.

  4. On the Zendesk API page, create an application.
    1. Go to the OAuth Clients tab, then click Add OAuth client.

    2. On the configuration page, complete the following settings.

      • Client name: Specify a name to help you identify it.
      • Description: Optional. Set a short description for the application.
      • Company: Optional. Set the company name for the application. This field is auto-populated with your organization's name.
      • Logo: Optional. Set a logo for the application.
      • Unique identifier: The field is auto-populated with a reformatted version of Client name.
        Note: Note down the unique identifier as you will need it later.
      • Redirect URLs: Paste the redirect URL obtained from the PBX.
    3. Click Save.
    4. In the pop-up window, click OK.

      After the page refreshes, a Secret field appears on the lower side, displaying the secret of the application.

    5. Click Copy and note down the secret.
      Important: Make sure that you copy and properly store the secret before you leave the current web page, as the secret only displays once. Otherwise you will have to re-generate a new one.

Step 3. Make authorization request to Zendesk

  1. Log in to PBX web portal, go to Integrations > Helpdesk.
  2. On the right side of Zendesk, click Integrate.
  3. In the Authorization section, fill in the following information.

    • Unique Identifier: Paste the unique identifier of the Zendesk application.
    • Secret: Paste the secret of the Zendesk application.
    • Your Zendesk Address Subdomain: Enter your Zendesk subdomain.
      Tip: You can get the subdomain from your Zendesk account's URL https://{subdomain}

  4. Click Save.

    A new browser web page will be launched, indicating that the Zendesk application requests to access data in your Zendesk account.

  5. Click Allow to proceed.

    If the authorization succeeds, the web page will display "Authorization succeeded!".

    On the PBX configuration page, a pop-up window displays the integration authentication result.

  6. Click OK to confirm.

    The Status field displays Connected, indicating that Yeastar P-Series Software Edition is connected to Zendesk successfully.

Step 4. Associate Zendesk users with PBX extensions

  1. On the Zendesk integration page of the PBX, click beside Zendesk User to obtain the latest list of Zendesk users.

  2. Associate the Zendesk users with PBX extensions.
    Associate automatically
    If users bind the same email address to their Zendesk accounts and PBX extensions, you can implement automatic association of their Zendesk accounts and PBX extensions.

    1. Click Associate Automatically.
    2. On the pop-up window, click OK.
    3. Click Save.
    Associate manually
    If a user binds different email addresses to his or her Zendesk account and PBX extension, you need to manually associate the user's Zendesk account and PBX extension.

    1. In the Extension drop-down list beside a desired Zendesk user, select the user's PBX extension.
    2. Click Save.


  • The integration of Yeastar P-Series Software Edition and Zendesk is set up.
  • Associated Zendesk users can make or receive calls with their PBX extensions.

What to do next