Zendesk
Zendesk provides software-as-a-service CRM-based products related to customer support, sales, and other customer communications. The Zendesk component allows you to manage users and tickets inside your Zendesk domain. It aims to help support, sales, and customer success teams engage their customers better. Zendesk helps you to resolve your customer issues by offering a various range of features.
Authorization
OAuth 2.0
The Zendesk component authenticates requests with OAuth 2.0. To configure an application inside Zendesk follow the directions in this guide Now, you will have to create a new Zendesk connection in Zendesk. When you create your Zendesk app, you must be sure to enter Sapper's OAuth callback URL -Sapper.
OAuth2.0 provides a secure way for your application to access Zendesk data without having to store and use the passwords of Zendesk users, which is sensitive information. To use OAuth authentication, you need to register your application with Zendesk. You also need to add some functionality to your application to support the OAuth authorization flow.
You must register your application to generate OAuth credentials that your application can use to authenticate API calls to Zendesk.
For Client ID enter the unique identifier of your app inside the Zendesk admin dashboard. For Client Secret enter the generated client secret you received from the Zendesk admin dashboard.
For Scopes refer to the guide that was linked above. There is detailed information on picking the correct scope.
You can find your subdomain inside of your Zendesk URL: https://{YOUR SUBDOMAIN HERE}.zendesk.com/
For more details please visit: https://developer.zendesk.com/documentation/ticketing/working-with-oauth/creating-and-using-oauth-tokens-with-the-api/
Input | Key | Example |
|---|---|---|
Authorize URL | It is an OAuth 2.0 authorization URL for Zendesk | |
Client ID | The Client ID is a public identifier of your application. It is a combination of various alphabetic. | Searchunifyandzendesk |
Client Secret | The Client Secret is confidential and should only be used to authenticate your application and make requests to APIs. It will be in the form of a URL. |
|
Scopes | A space-delimited set of one or more scopes to get the user's permission to access. | read write |
Subdomain | Provide a string value for the subdomain that your site lives in. You can find your subdomain in your Zendesk URL https://<SUBDOMAIN>.zendesk.com/admin/home | acmeInc |
Token URL | It is an OAuth 2.0 token URL for Zendesk. |
Zendesk Connections
Zendesk OAuth2.0 Connection
Input | Key | Description | Example |
Select Application | application | Select Zendesk application |
|
Connection Type | connection type | Select the type of connection. | REST |
REST Connection Type | rest connection type | Select the type of REST connection. | OAuth2.0 |
Connection Name | name | Provide a name for the connection. | Zendesk connection |
Connection Description | description | Provide a description for the connection. |
|
Host Name | host | Provide a string value for the URL of user's Zendesk account. |
|
Grant Type | grant type | Provide the grant type - authorization code, password, client credentials. |
|
Actions
Search User by Email
Search User by Email | key: searchUserbyEmail
Input | Key | Description | Example |
|---|---|---|---|
emailID | Provide an appropriate email id. An email address is the identification of an electronic mailbox. It has two parts, namely, a local part and the domain. |
Create User
Create User | key: createUser
Input | Key | Description | Example |
|---|---|---|---|
User Name | userName | User name is an identification used by a person to access an web service. a can be a combination of various alphabetic. | KARENB |
emailID | Provide an appropriate email id. It is the identification of an electronic mailbox. It has two parts, namely, a local part and the domain. | ||
Organization Name | organizationName | Mention the name of the organization. | Sapper |
Update User
Update User | key: updateUser
Input | Key | Description | Example |
|---|---|---|---|
Name | name | Mention the name of the user. | Sample |
User ID | userID | Provide the appropriate user id. A User identification or user id is an entity used to identify a user on a website, software, system, or within a generic IT environment. It is the most common authentication mechanism used within computing systems. It can be an alphanumeric combination. | jbu3470 |
Create Ticket
Create Ticket | key: createTicket
Input | Key | Description | Example |
|---|---|---|---|
Subject | subject | Provide an appropriate subject. The subject field is a brief description of the message. |
|
Description | description | Provide an appropriate description. A description is a statement that gives details about something. |
|
Priority | priority | Priority show either all values or only normal and high values. You can create a custom ticket field to track any custom priority values you want to include in your workflow. | High, Medium and Low |