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 zero-ETL engine 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

Table definitions & examples →

Get started

Install

Download and install the latest Zendesk plugin:

steampipe plugin install zendesk

Credentials

Item	Description
Credentials	Zendesk requires an API token, subdomain and email for all requests.
Permissions	You must be an administrator of your domain to create an API token.
Radius	A Zendesk connection is scoped to a single Zendesk account, with a single set of credentials.
Resolution	1. 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.

Postgres FDW

This plugin is available as a native Postgres FDW. Unlike Steampipe CLI, which ships with an embedded Postgres server instance, the Postgres FDW can be installed in any supported Postgres database version.

You can download the tarball for your platform from the Releases page, but it is simplest to install them with the steampipe_postgres_installer.sh script:

/bin/sh -c "$(curl -fsSL https://steampipe.io/install/postgres.sh)" -- zendesk

The installer will prompt you for the plugin name and version, download and install the appropriate files for your OS, system architecture, and Postgres version.

To configure the Postgres FDW, you will create an extension, foreign server, and schema and import the foreign schema.

CREATE EXTENSION IF NOT EXISTS steampipe_postgres_zendesk;
CREATE SERVER steampipe_zendesk FOREIGN DATA WRAPPER steampipe_postgres_zendesk OPTIONS (config '<your_config>');
CREATE SCHEMA zendesk;
IMPORT FOREIGN SCHEMA zendesk FROM SERVER steampipe_zendesk INTO zendesk;

SQLite Extension

This plugin is available as a SQLite Extension, making the tables available as SQLite virtual tables.

You can download the tarball for your platform from the Releases page, but it is simplest to install them with the steampipe_sqlite_installer.sh script:

/bin/sh -c "$(curl -fsSL https://steampipe.io/install/sqlite.sh)" -- zendesk

The installer will prompt you for the plugin name, version, and destination directory. It will then determine the OS and system architecture, and it will download and install the appropriate package.

To configure the SQLite extension, load the extension module and then run the steampipe_configure_zendesk function to configure it with plugin-specific options.

$ sqlite3
sqlite> .load ./steampipe_sqlite_extension_zendesk.so
sqlite> select steampipe_configure_zendesk('<your_config>');

Export

This plugin is available as a standalone Export CLI. Steampipe exporters are stand-alone binaries that allow you to extract data using Steampipe plugins without a database.

You can download the tarball for your platform from the Releases page, but it is simplest to install them with the steampipe_export_installer.sh script:

/bin/sh -c "$(curl -fsSL https://steampipe.io/install/export.sh)" -- zendesk

You can pass the configuration to the command with the --config argument:

steampipe_export_zendesk --config '<your_config>' <table_name>