Zendesk with Visual Studio Team Services

Last Update: 3/6/2017

If you use Zendesk to support your customers, you can create work items in Visual Studio Team Services directly from your Zendesk tickets. Then you can configure Visual Studio Team Services to update the Zendesk ticket when the work item is updated.

Install the Team Services app for Zendesk

  1. Download the .zip file that contains the Visual Studio Team Services for Zendesk app from GitHub.

  2. If you don't have a Zendesk account, get one.

  3. Go to your Zendesk administration page to mange your apps.

    Zendesk administer page, manage button

  4. Upload the Visual Studio Team Services for Zendesk app .zip file

    Upload app button on Zendesk manage apps page

  5. Install and configure the app

    Visual Studio Team Services for Zendesk installation page with the work item tag

    If you use a work item tag, work items you create from Zendesk will have that tag. Later, you can use it to find items that were created from Zendesk.

Authenticating

Each user of the app must provide credentials so that the Team Services app can create and query work items as that user. Creating a personal access token is recommended.

  1. Navigate to the Team Services account you associated with your Zendesk account (from step 5 above)

  2. Open the profile menu and select Security

    Profile menu

  3. Create a personal access token

    Zendesk ticket page, Apps button, login

    Suggestions:

    • Give the token a recognizable name so you can find it later if you need to revoke it or check its expiration date
    • Scope the token to the account associated with Zendesk
    • Limit to at least Work item (read and write)
  4. Copy the token and paste it into the Password field of the Team Services app in Zendesk

    Profile menu

    • If you are running version 0.5.0 or higher of the app, you do not need to specify a Username. Otherwise, supply any value into the Username field (for example "me").

Create a work item from Zendesk

  1. Go to a ticket in Zendesk and log in to the Visual Studio Team Services for Zendesk app.

    Zendesk ticket page, Apps button, login

  2. Add a work item to Visual Studio Team Services based on this ticket.

    Visual Studio Team Services for Zendesk, new work item

  3. Create the work item.

    Create work item dialog box

  4. Open the work item in Visual Studio Team Services directly from Zendesk.

    Zendesk ticket with work item

    In Visual Studio Team Services, the work item is tagged with the tag you set up , and it's linked back to the ticket in Zendesk.

    Work item in Visual Studio Team Services with tag and link to Zendesk ticket

Configure Visual Studio Team Services to update Zendesk tickets

Close the loop by configuring Visual Studio Team Services to update the Zendesk tickets whenever there's a change in the work items that were created from Zendesk.

  1. Go to the your Zendesk API administration page.

    Zendesk administration, APIs

  2. Enable token access and copy your token.

    Channels/tokens with token access enabled

  3. Go to a team project in your Visual Studio Team Services account and open the project adminstration page.

    Administration icon on the team project home page

  4. On the service hooks tab, add a service hook.

    Team project administration page, service hooks tab, add icon

  5. Start configuring Zendesk.

    Sevice hooks tab, Zendesk selected

  6. Use the Work item is commented on event. You can filter for comments, too. For example, you can only act on comments that contain the string "Zendesk:" and only those comments will be reflected back to Zendesk.

    Configure the event dialog box with the tag set to Zendesk:

  7. Configure the action that Zendesk will take in response to that event. This is where you provide the Zendesk access token.

    Configure action dialog box

Now when you update the work item, a private comment will be added to the Zendesk ticket.

Q & A

Q: Why do I keep getting prompted for a user name and password?

A: If you supplied a Personal Access Token (recommended) in the login panel of the app, make sure the token is scoped either to "all accessible accounts" or to the specific Team Services account configured in the app's settings. To open the app settings from Zendesk go to Settings > Apps > Manage.

Also make sure the token has not expired and that it has the Work items (read and write) scope.

For more details, see the Authenticating section above or the Authenticate access with personal access tokens topic.

Q: Can I programmatically create subscriptions?

A: Yes, use the REST APIs.