Integration with Zendesk Chat

How it works

Who can use it

Partners who have already integrated Login and have a Zendesk Chat account.

How to get it

To link a visitor:

1. Authenticate a user in your Login project by one of the following requests:
   • Authentication via username and password (JWT and OAuth 2.0).
   • Authentication via social networks (JWT and OAuth 2.0).
2. Generate a Zendesk JWT.
3. Authenticate a visitor into Zendesk Chat.

Generating Zendesk JWT

The Zendesk JWT is based on a token received from the Xsolla Login server when authenticating a user in your Login project. You can store a token in cookie files on a required domain and add it to a HTTP request when generating a Zendesk JWT.

You can also set your own format of a response when implementing the call.

Below is a simplified version of a Zendesk JWT getting flow based on Go. The full Zendesk JWT generation code is found on GitHub.

Install the following packages before generating a JWT:

1go get github.com/dgrijalva/jwt-go
2go get github.com/rs/cors

To get a Zendesk JWT:

1. Validate a JWT.
2. Decode a JWT.
3. Form a list of JWT claims.
4. Sign a JWT.

Validating JWT

 1cookie, err := r.Cookie("token")
 2
 3token, err := jwt.Parse(cookie.Value, func(token *jwt.Token) (interface{}, error) {
 4  if _, ok := token.Method.(*jwt.SigningMethodHMAC); !ok {
 5    return nil, errors.New("unexpected signing method")
 6  }
 7  return []byte(loginSecret), nil
 8})
 9
10var loginClaims jwt.MapClaims
11var ok bool
12if loginClaims, ok = token.Claims.(jwt.MapClaims); !ok || !token.Valid {
13  writeErrorResponse(w, "00-01", "Token is invalid", http.StatusUnauthorized)
14  return
15}

Decoding JWT

• email — an email address
• sub — user ID

1var sub, email string
2sub, _ = loginClaims["sub"].(string)
3email, _ = loginClaims["email"].(string)

Forming list of JWT claims

1zendeskClaims := jwt.MapClaims{}
2zendeskClaims["name"] = email
3zendeskClaims["email"] = email
4zendeskClaims["external_id"] = sub
5zendeskClaims["iat"] = time.Now().UTC().Unix()

Signing JWT

1zendeskToken := jwt.NewWithClaims(jwt.SigningMethodHS256, zendeskClaims)
2zendeskTokenString, _ := zendeskToken.SignedString([]byte(zendeskSecret))

Authenticating visitor into Zendesk Chat

This allows adding the following visitor data to Zendesk Chat:

• name
• email address
• identifier

Use a received Zendesk JWT to authenticate a visitor into Zendesk Chat. Initialize the Web SDK with the authentication option in the following way:

 1zChat.init({
 2  account_key: ACCOUNT_KEY,
 3  authentication: {
 4    jwt_fn: function(callback) {
 5      fetch('https://example.com:8001/generate/token', {
 6        credentials: "include"
 7      }).then(function(res) {
 8        res.text().then(function(body) {
 9          const jwt = JSON.parse(body).token;
10          callback(jwt)
11        });
12      });
13    }
14  }
15});

The visitor authentication flow is described in the instruction and Web SDK.

Working with visitor

After successful authentication, a visitor will be displayed in your Zendesk Chat account > Visitors module.

For working with the Visitors endpoint, you will need to get a token (instruction). When working with data of a visitor who is linked to your Login project:

1. Get visitor data.
2. Visitor is linked to your Login project.

Getting visitor data

To execute the Show Visitor request, you should get Visitor ID. You can find it in your Zendesk Chat account by choosing a required visitor.

Example of the Show Visitor request:

1GET https://www.zopim.com/api/v2/visitors/9855790-xjj3u5xPWhW1Fv HTTP/1.1
2Authorization: Bearer <token>

1curl --request GET \
2  --url https://www.zopim.com/api/v2/visitors/9855790-xjj3u5xPWhW1Fv \
3  --header 'authorization: bearer_token'

Example of the response:

 1HTTP/1.1 200 OK
 2Content-Type: application/json
 3
 4{
 5  "banned": false,
 6  "notes": "",
 7  "id": "9855790.xjj3ukxyIhn6j3",
 8  "email": "[email protected]",
 9  "phone": "",
10  "created": 1586950554,
11  "name": "[email protected]",
12  "external_id": "82cd5e0c-c3ff-11e9-b199-c1e5fc81c37f"
13}

 1{
 2  "banned": false,
 3  "notes": "",
 4  "id": "9855790.xjj3ukxyIhn6j3",
 5  "email": "[email protected]",
 6  "phone": "",
 7  "created": 1586950554,
 8  "name": "[email protected]",
 9  "external_id": "82cd5e0c-c3ff-11e9-b199-c1e5fc81c37f"
10}

Checking visitor linking to Login project