Table: zendesk_brand - Query Zendesk Brands using SQL

A Brand in Zendesk is a unique identity that you can create within your account. It includes a brand name, host mapping, subdomain, and other details. Brands in Zendesk allow you to provide customer service for multiple brands, products, or services using a single Zendesk account.

Table Usage Guide

The zendesk_brand table provides insights into Brands within Zendesk. As a customer service manager, explore brand-specific details through this table, including brand name, host mapping, subdomain, and more. Utilize it to manage and monitor multiple brands, products, or services using a single Zendesk account.

Examples

Get brand information

Explore the specific details of a particular brand in your Zendesk account to better understand its characteristics and settings. This is particularly useful when you need to assess the brand's configuration for troubleshooting or optimization purposes.

select
  *
from
  zendesk_brand
where
  id = '1234';

select
  *
from
  zendesk_brand
where
  id = '1234';

Schema for zendesk_brand

Name	Type	Operators	Description
_ctx	jsonb		Steampipe context in JSON form.
active	boolean		If the brand is set active
brand_url	text		The URL of the brand
created_at	timestamp with time zone		The time the brand was created
default	boolean		Is the brand the default brand for this account
has_help_center	boolean		If the brand has a Help Center
help_center_state	text		The state of the Help Center. Allowed values are "enabled", "disabled", or "restricted".
host_mapping	text		The hostmapping to this brand, if any. Only admins can view this property.
id	text	=	Automatically assigned when the brand is created
logo_content_type	text		The content type of the image. Example value: "image/png"
logo_content_url	text		A full URL where the attachment image file can be downloaded
logo_file_name	text		The name of the image file
logo_id	bigint		Automatically assigned when created
logo_inline	boolean		If true, the attachment is excluded from the attachment list and the attachment's URL can be referenced within the comment of a ticket. Default is false
logo_size	bigint		The size of the image file in bytes
logo_thumbnails	jsonb		An array of attachment objects
name	text		The name of the brand
signature_template	text		The signature template for a brand
sp_connection_name	text	=, !=, ~~, ~~, !~~, !~~	Steampipe connection name.
sp_ctx	jsonb		Steampipe context in JSON form.
subdomain	text	=, !=, ~~, ~~, !~~, !~~	The organization subdomain name of the Zendesk instance.
ticket_form_ids	jsonb		The ids of ticket forms that are available for use by a brand
updated_at	timestamp with time zone		The time of the last update of the brand
url	text		The API URL of the brand

Export

This table is available as a standalone Exporter 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>' zendesk_brand