Zendesk integration

Authentication

Supported authentication methods

• Basic (username and password)
• Personal token
• OAuth

Basic authentication

In order to use Basic authentication, you need to enable "Password access" in Zendesk. Follow steps below to do that.

Navigate to your Zendesk and switch to Admin area.

Locate the Channels section and click on API item there

Switch Password Access to Enabled.

Now, when you've enabled basic authentication in Zendesk, lets configure integration in Bugsee.

Start Bugsee integration wizard and select "Basic authentication" in the first step of integration wizard. Click "Next".

Provide valid host (URL to your Zendesk), username and password.

Personal tokens

In order to use Personal tokens, you need to enable "Token access" in Zendesk. Follow steps below to do that.

Navigate to your Zendesk and switch to Admin area.

Locate the Channels section and click on API item there

Switch Token Access to Enabled.

Now, when you've enabled token access in Zendesk, lets configure integration in Bugsee.

Start Bugsee integration wizard and select "Personal token" in the first step of integration wizard. Click "Next".

Provide valid host (URL to your Zendesk), and paste your token. Click "Next".

OAuth

Select "OAuth" in the first step of integration wizard. Click Next.

You will be presented with dialog asking you to authorize Bugsee. Click "Allow" to allow Bugsee access your Zendesk.

Configuration

There are no any specific configuration steps for Zendesk. Refer to configuration section for description about generic steps.

Custom recipes

Bugsee can accommodate all the customizations required for your Zendesk with the help of custom recipes. This section provides a few examples of using custom recipes specifically with JIRA. For basic introduction, refer to custom recipe documentation.

Setting tags field

By default Bugsee creates and updates Zendesk tickets with Bugsee issue labels as Zendesk tags. But labels list can be overridden inside your custom recipe. For example you can add some new label (Zendesk tag) to existing ones:

function create(context) {
    // ....

    return {
        // ...
        labels: [...issue.labels, "My awesome tag"]
    };
}

function update(context, changes) {
    const result = {};
    // ...

    if (changes.labels) {
        result.labels = [...changes.labels.to, "My awesome tag"];
    }

    return {
        issue: {
            custom: {}
        },
        changes: result
    };
}

Setting resource type

Bugsee creates Zendesk tickets by default. But also allows to create entities with different resource type, for example requests. You just need to tweak custom field inside your custom recipe:

function create(context) {
    // ....

    return {
        // ...
        custom: {
          as: "request"
      }
    };
}