turbot/steampipe-plugin-zendesk

Use SQL to instantly query Zendesk. Open source CLI. No DB required.

Zendesk Plugin for Steampipe

• Get started →
• Documentation: Table definitions & examples
• Community: Join #steampipe on Slack →
• Get involved: Issues

Quick start

Install the plugin with Steampipe:

steampipe plugin install zendesk

Run a query:

select
  id,
  created_at,
  subject
from
  zendesk_ticket;

Engines

This plugin is available for the following engines:

Engine	Description
Steampipe	The Steampipe CLI exposes APIs and services as a high-performance relational database, giving you the ability to write SQL-based queries to explore dynamic data. Mods extend Steampipe's capabilities with dashboards, reports, and controls built with simple HCL. The Steampipe CLI is a turnkey solution that includes its own Postgres database, plugin management, and mod support.
Postgres FDW	Steampipe Postgres FDWs are native Postgres Foreign Data Wrappers that translate APIs to foreign tables. Unlike Steampipe CLI, which ships with its own Postgres server instance, the Steampipe Postgres FDWs can be installed in any supported Postgres database version.
SQLite Extension	Steampipe SQLite Extensions provide SQLite virtual tables that translate your queries into API calls, transparently fetching information from your API or service as you request it.
Export	Steampipe Plugin Exporters provide a flexible mechanism for exporting information from cloud services and APIs. Each exporter is a stand-alone binary that allows you to extract data using Steampipe plugins without a database.
Turbot Pipes	Turbot Pipes is the only intelligence, automation & security platform built specifically for DevOps. Pipes provide hosted Steampipe database instances, shared dashboards, snapshots, and more.

Developing

Prerequisites:

• Steampipe
• Golang

Clone:

git clone https://github.com/turbot/steampipe-plugin-zendesk.git
cd steampipe-plugin-zendesk

Build, which automatically installs the new version to your ~/.steampipe/plugins directory:

make

Configure the plugin:

cp config/* ~/.steampipe/config
vi ~/.steampipe/config/zendesk.spc

Try it!

steampipe query
> .inspect zendesk

Further reading:

• Writing plugins
• Writing your first table

Open Source & Contributing

This repository is published under the Apache 2.0 (source code) and CC BY-NC-ND (docs) licenses. Please see our code of conduct. We look forward to collaborating with you!

Steampipe is a product produced from this open source software, exclusively by Turbot HQ, Inc. It is distributed under our commercial terms. Others are allowed to make their own distribution of the software, but cannot use any of the Turbot trademarks, cloud services, etc. You can learn more in our Open Source FAQ.

Get Involved

Join #steampipe on Slack →

Want to help but don't know where to start? Pick up one of the help wanted issues:

• Steampipe
• Zendesk Plugin

steampipe-plugin-zendesk's Issues

There is some broken formatting on the API Token link under Configuration Arguments in docs

There is some broken formatting on the API Token link under Configuration Arguments:

Improve example query in zendesk_organization

Is your feature request related to a problem? Please describe.
zendesk_organization > Get ticket counts by organization example query has unwanted ' at the end

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Update steampipe-plugin-sdk to v1.6.1

Add CHANGELOG for v0.2.1

Update zendesk_ticket to latest SDK version - looking for `custom_status_id` column

Describe the solution you'd like
I am looking for custom_status_id column in the zendesk_ticket table.
Reference at: https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/#show-ticket
Not sure if this will also require a new table "zendesk_ticket_statuses" (https://developer.zendesk.com/api-reference/ticketing/tickets/custom_ticket_statuses/) or just a hydrated column but I am looking for the "custom_status" of a given ticket. Thank you!

Using: zendesk@latest - 0.8.0
$ steampipe -v
Steampipe v0.22.0

v0.2.3

Incorrect subdomain in config results in panic

To repro:

1. Configure the subdomain as, e.g., turbothelp.zendesk.com (instead of just turbothelp as it should be)

2. select * from zendesk user

rror: rpc error: code = Internal desc = hydrate function listUser failed with panic runtime error: invalid memory address or nil pointer dereference (SQLSTATE HV000)

This was the motivation for https://github.com/turbot/steampipe-plugin-zendesk/pull/25/files

`where..in` and `join` dont work with `zendesk_search`

These errors are related to turbot/steampipe-postgres-fdw#3

select
  result_number,
  jsonb_pretty(result)
from
  zendesk_search,
  github_my_organization
where
  query = 'type:organization' || login;
Error: 'List' call requires an '=' qual for column: query

 select
  result_number,
  jsonb_pretty(result)
from
  zendesk_search,
  github_my_organization
where
  query = login;
Error: 'List' call requires an '=' qual for column: query

update docs/index.md for config file options

Add CHANGELOG for v0.2.0

v0.2.2

v0.3.0

Improve documentation for zendesk_brand table

Is your feature request related to a problem? Please describe.

Doing a select * from zendesk_brand table returns a cryptic error message:

select * from zendesk.zendesk_brand;
rpc error: code = Internal desc = 'Get' call requires an '=' qual for column:'id' operator: =

Time: 0.037s
vhadianto@0001:yca4wa>   

This is because this table only defines a get call not a list call.

Describe the solution you'd like

Improve docs to warn users that doing a select * from zendesk_brand will not work.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.