turbot/zendesk

steampipe plugin install zendesksteampipe plugin install zendesk

Zendesk + Turbot

Zendesk is a customer service SaaS platform with 200,000+ customers. It enables organizations to provide customer service via text, mobile, phone, email, live chat, social media.

Steampipe is an open source CLI to instantly query cloud APIs using SQL.

For example:

select
id,
created_at,
assignee_id,
subject
from
zendesk_ticket
where
status = 'open';
+------+---------------------+--------------+----------------------------------+
| id | created_at | assignee_id | subject |
+------+---------------------+--------------+----------------------------------+
| 4582 | 2021-04-09 14:53:25 | 383110186421 | Need help with Export |
| 4579 | 2021-04-08 21:19:23 | 383110186421 | DB and Workspace Scaling Options |
| 4577 | 2021-04-07 23:27:21 | 383110186421 | How do i create a Report? |
+------+---------------------+--------------+----------------------------------+

Documentation

Get started

Install

Download and install the latest Zendesk plugin:

steampipe plugin install zendesk

Credentials

ItemDescription
CredentialsZendesk requires an API token, subdomain and email for all requests.
PermissionsYou must be an administrator of your domain to create an API token.
RadiusA Zendesk connection is scoped to a single Zendesk account, with a single set of credentials.
Resolution1. Credentials specified in environment variables e.g. ZENDESK_TOKEN.
2. Credentials in the Steampipe configuration file (~/.steampipe/config/zendesk.spc)

Configuration

Installing the latest aws plugin will create a config file (~/.steampipe/config/zendesk.spc) with a single connection named zendesk:

connection "zendesk" {
plugin = "zendesk"
subdomain = "dmi"
email = "pam@dmi.com"
token = "17ImlCYdfZ3WJIrGk96gCpJn1fi1pLwVdrb23kj4"
}
  • subdomain - The subdomain name of your Zendesk account.
  • email - Email address of agent user who have permission to access the API.
  • token - API token for your Zendesk instance.

Get involved