Zendesk

Adicionando o conector

Requisitos

Instruções

  1. Entre na sua conta do zendesk com um acesso de Owner/Administrator
  2. Uma vez na sua conta, selecione na barra lateral esquerda o ícone da engrenagem (configurações), depois vá em Canais e depois API
  3. Em APIs, habilite o acesso por token e, depois, clique em adicionar novo
  4. Na página de edição do novo token, dê um nome para ele (por exemplo, integração Kondado), copie o valor gerado e clique em Salvar
  5. Na plataforma da Kondado, clique em CRIAR+> Conector > e selecione o conector do Zendesk
  6. Preencha as informações da imagem abaixo da seguinte forma
    1. Nome: o nome da sua integração, por exemplo, “Zendesk”
    2. E-mail (Owner) o e-mail do Owner da conta do Zendesk
    3. Token: O token gerado no passo (4)
    4. Sub-domínio: o seu subdomínio do zendesk. Por exemplo, se o seu endereço no zendesk é empresa.zendesk.com, o seu subdomínio é empresa

Caso a sua conta do Zendesk tenha habilitado o bloqueio de IPs para acesso, libere também os IPs da Kondado

Integrações

Índice

Gráfico de relacionamento

Clique para ampliar

Closed and Deleted Tickets

Tipo de replicacao: Incremental

Tickets excluídos do Zendesk com autor, status e datas.

Campo Tipo

id

text

[pt] Identificador único do ticket.

actor_id

text

[pt] Identificador do ator (agente ou usuário) que realizou a exclusão.

actor_name

text

[pt] Nome exibido do ator que excluiu o ticket.

deleted_at

timestamp

[pt] Data e hora em que o ticket foi excluído.

description

text

[pt] Descrição ou conteúdo principal do ticket excluído.

previous_state

text

[pt] Status do ticket antes da exclusão (ex.: solved, closed).

subject

text

[pt] Assunto/título do ticket excluído.

Comentários dos tickets

Tipo de replicacao: Incremental

Comentários dos tickets com informações de autor e criação.

Campo Tipo

ticket_id

text

[pt] Identificador do ticket ao qual o comentário pertence.

    Tickets > > id

id

text

[pt] Identificador do comentário.

author_id

text

[pt] Identificador do usuário que escreveu o comentário.

    Usuários > > id

created_at

timestamp

[pt] Quando o comentário foi criado.

public

boolean

[pt] Indica se o comentário é público.

body

text

[pt] Corpo do comentário em texto.

Eventos das métricas dos tickets

Tipo de replicacao: Incremental

Histórico de eventos de métricas de SLA de tickets (aplicar, pausar, violar, atualizar status).

Campo Tipo

id

text

[pt] Identificador único do evento de métrica.

deleted

boolean

[pt] Disponível em eventos de violação; ignore quando verdadeiro.

group_sla_business_hours

boolean

[pt] Indica se o SLA de grupo usa horário comercial.

group_sla_policy_description

text

[pt] Descrição da política de SLA de grupo aplicada.

group_sla_policy_title

text

[pt] Título da política de SLA de grupo aplicada.

group_sla_policy_id

text

[pt] Para eventos apply_group_sla: ID da política de SLA de grupo aplicada.

group_sla_target

float

[pt] Alvo de SLA de grupo aplicado (eventos apply_group_sla).

instance_id

text

[pt] Número da instância do evento de métrica (incrementa por ticket).

metric

text

[pt] Métrica rastreada (ex.: agent_work_time, reply_time, requester_wait_time).

sla_business_hours

boolean

sla_policy_description

text

[pt] Descrição da política de SLA aplicada.

sla_policy_title

text

[pt] Título da política de SLA aplicada.

sla_policy_id

text

[pt] Disponível em eventos apply_sla: ID da política de SLA aplicada.

sla_target

float

[pt] Alvo de SLA aplicado (eventos apply_sla).

status_business

float

[pt] Para eventos update_status: minutos em aberto em horário comercial.

status_calendar

float

[pt] Para eventos update_status: minutos em aberto em horas corridas.

ticket_id

text

[pt] Identificador do ticket associado.

    Tickets > > id

time

timestamp

[pt] Timestamp em que o evento ocorreu.

type

text

[pt] Tipo do evento de métrica (activate, pause, fulfill, apply_sla, breach, update_status, measure).

Grupos

Tipo de replicacao: Integral

Grupos do Zendesk com informações de status e associação.

Campo Tipo

id

text

[pt] Identificador único do grupo.

updated_at

timestamp

[pt] Quando o grupo foi atualizado pela última vez.

default

boolean

[pt] Indica se este é o grupo padrão da conta.

name

text

[pt] Nome do grupo.

url

text

[pt] URL do registro do grupo.

created_at

timestamp

[pt] Quando o grupo foi criado.

deleted

boolean

[pt] Indica se o grupo está marcado como excluído.

description

text

[pt] Descrição do grupo.

Histórico dos tickets

Tipo de replicacao: Incremental

Objeto principal

Auditorias de alterações de tickets com metadados de canal e autor.

Campo Tipo

id

text

[pt] Identificador único do evento de auditoria.

ticket_id

text

[pt] Identificador do ticket associado à auditoria.

    Tickets > > id

via__source__to__name

text

[pt] Nome de destino capturado nos metadados do canal.

via__source__to__address

text

[pt] Endereço de destino capturado nos metadados do canal.

via__source__from__original_recipients

text

[pt] Receptores originais listados nos metadados do canal.

via__source__from__name

text

[pt] Nome da origem capturado nos metadados do canal.

via__source__from__address

text

[pt] Endereço de origem capturado nos metadados do canal.

via__source__rel

text

[pt] Indicador de relação nos metadados de origem.

via__channel

text

[pt] Canal pelo qual a ação auditada ocorreu.

created_at

timestamp

[pt] Quando o evento de auditoria foi criado.

author_id

text

[pt] Usuário que gerou o evento de auditoria.

metadata__system__latitude

float

[pt] Latitude registrada nos metadados do sistema, quando disponível.

metadata__system__client

text

[pt] User agent do cliente registrado nos metadados do sistema.

metadata__system__ip_address

text

[pt] Endereço IP registrado nos metadados do sistema.

metadata__system__location

text

[pt] Localização derivada dos metadados do sistema.

metadata__system__longitude

float

[pt] Longitude registrada nos metadados do sistema, quando disponível.

zendesk_ticket_audits__events

Eventos que compõem cada auditoria de ticket, incluindo tipo e conteúdo.

Campo Tipo

audit_id

text

[pt] Identificador da auditoria pai.

events__data

text

[pt] Conteúdo bruto do evento de auditoria.

events__type

text

[pt] Tipo do evento de auditoria.

events_id

text

[pt] Identificador do evento dentro da auditoria.

Links Jira

Tipo de replicacao: Integral

Vínculos entre tickets do Zendesk e issues do Jira.

Campo Tipo

id

text

[pt] Identificador do registro de vínculo.

ticket_id

text

[pt] ID do ticket relacionado no Zendesk.

    Tickets > > id

issue_id

text

[pt] ID da issue correspondente no Jira.

issue_key

text

[pt] Chave da issue vinculada no Jira.

url

text

[pt] URL do registro de vínculo.

created_at

timestamp

[pt] Quando o vínculo foi criado.

updated_at

timestamp

[pt] Quando o vínculo foi atualizado pela última vez.

Marcas

Tipo de replicacao: Integral

Objeto principal

Campo Tipo

id

text

[pt] O identificador único da marca no Zendesk.

active

boolean

[pt] Especifica se a marca está atualmente ativa no Zendesk.

brand_url

text

[pt] A URL pública da marca, normalmente usada pelos clientes para acessar o help center ou site de suporte.

default

boolean

[pt] Indica se esta marca está configurada como a marca padrão da conta Zendesk.

has_help_center

boolean

[pt] Indica se a marca possui um Help Center ativo.

help_center_state

text

[pt] O estado atual do Help Center da marca (ex.: habilitado, desabilitado).

host_mapping

text

[pt] O mapeamento de host personalizado (CNAME) usado para vincular o site de suporte da marca a um domínio customizado.

is_deleted

boolean

[pt] Especifica se a marca foi excluída do Zendesk.

logo_content_type

text

[pt] O tipo MIME do arquivo do logotipo (ex.: image/png).

logo_content_url

text

[pt] A URL direta onde a imagem do logotipo pode ser acessada.

logo_deleted

boolean

[pt] Especifica se o arquivo do logotipo foi excluído.

logo_file_name

text

[pt] O nome do arquivo da imagem do logotipo.

logo_height

float

[pt] A altura da imagem do logotipo em pixels.

logo_id

text

[pt] O identificador único do anexo do logotipo.

logo_inline

boolean

[pt] Indica se o logotipo deve ser exibido inline.

logo_mapped_content_url

text

[pt] A URL mapeada da imagem do logotipo, geralmente igual à content_url.

logo_size

float

[pt] O tamanho do arquivo do logotipo em bytes.

logo_url

text

[pt] A URL do endpoint da API para recuperar os detalhes do anexo do logotipo da marca.

logo_width

float

[pt] A largura da imagem do logotipo em pixels.

name

text

[pt] O nome da marca (ex.: Torra).

subdomain

text

[pt] O subdomínio do Zendesk associado à marca.

url

text

[pt] A URL do endpoint da API para recuperar os detalhes da marca no Zendesk.

ticket_form_ids

text

signature_template

text

created_at

timestamp

updated_at

timestamp

zendesk_brands_logo_thumbnails

Campo Tipo

brand_id

text

[pt] O identificador único da marca no Zendesk.

logo_thumbnails_id

text

[pt] O identificador único do anexo da miniatura do logotipo.

logo_thumbnails_content_type

text

[pt] O tipo MIME do arquivo da miniatura (ex.: image/png).

logo_thumbnails_content_url

text

[pt] A URL direta onde a imagem em miniatura pode ser acessada.

logo_thumbnails_deleted

boolean

[pt] Especifica se o arquivo da miniatura foi excluído.

logo_thumbnails_file_name

text

[pt] O nome do arquivo da imagem em miniatura.

logo_thumbnails_height

float

[pt] A altura da imagem em miniatura em pixels.

logo_thumbnails_inline

boolean

[pt] Indica se a miniatura deve ser exibida inline.

logo_thumbnails_mapped_content_url

text

[pt] A URL mapeada da imagem em miniatura, geralmente igual à content_url.

logo_thumbnails_size

float

[pt] O tamanho do arquivo da imagem em miniatura em bytes.

logo_thumbnails_url

text

[pt] A URL do endpoint da API para recuperar uma versão em miniatura do logotipo.

logo_thumbnails_width

float

[pt] A largura da imagem em miniatura em pixels.

Métricas dos tickets

Tipo de replicacao: Incremental

Métricas de tickets do Zendesk Chat com tempos de espera, respostas e reaberturas.

Campo Tipo

ticket_id

text

[pt] Identificador do ticket associado.

    Tickets > > id

id

text

[pt] Identificador do registro de métricas do ticket.

updated_at

timestamp

[pt] Quando o registro de métricas foi atualizado pela última vez.

solved_at

timestamp

[pt] Quando o ticket foi resolvido.

replies

int

[pt] Quantidade de respostas públicas adicionadas por agentes.

full_resolution_time_in_minutes__calendar

float

[pt] Minutos até a resolução total (horas corridas).

full_resolution_time_in_minutes__business

float

[pt] Minutos até a resolução total (horário comercial).

on_hold_time_in_minutes__calendar

float

[pt] Minutos em espera em horas corridas.

on_hold_time_in_minutes__business

float

[pt] Minutos em espera em horário comercial.

status_updated_at

timestamp

[pt] Quando o status do ticket foi atualizado pela última vez.

assignee_stations

float

[pt] Quantidade de responsáveis diferentes que o ticket teve.

requester_updated_at

timestamp

[pt] Quando o solicitante atualizou o ticket pela última vez.

initially_assigned_at

timestamp

[pt] Quando o ticket foi atribuído pela primeira vez.

group_stations

float

[pt] Quantidade de grupos pelos quais o ticket passou.

first_resolution_time_in_minutes__calendar

float

[pt] Minutos até a primeira resolução (horas corridas).

first_resolution_time_in_minutes__business

float

[pt] Minutos até a primeira resolução (horário comercial).

assigned_at

timestamp

[pt] Quando o ticket foi atribuído.

latest_comment_added_at

timestamp

[pt] Quando o comentário mais recente foi adicionado.

reply_time_in_minutes__calendar

float

[pt] Minutos até a primeira resposta (horas corridas).

reply_time_in_minutes__business

float

[pt] Minutos até a primeira resposta (horário comercial).

url

text

[pt] URL do registro de métricas do ticket.

created_at

timestamp

[pt] Quando o registro de métricas foi criado.

assignee_updated_at

timestamp

[pt] Quando o responsável atualizou o ticket pela última vez.

reopens

float

[pt] Quantidade de vezes que o ticket foi reaberto.

requester_wait_time_in_minutes__calendar

float

[pt] Minutos de espera do solicitante (horas corridas).

requester_wait_time_in_minutes__business

float

[pt] Minutos de espera do solicitante (horário comercial).

agent_wait_time_in_minutes__calendar

float

[pt] Minutos de espera do agente (horas corridas).

agent_wait_time_in_minutes__business

float

[pt] Minutos de espera do agente (horário comercial).

Organizações

Tipo de replicacao: Integral

Organizações do Zendesk com domínios, configurações de compartilhamento, campos personalizados e datas.

Campo Tipo

id

text

[pt] Identificador único da organização.

shared_comments

boolean

[pt] Permite que usuários da organização vejam comentários de outros em tickets.

updated_at

timestamp

[pt] Quando a organização foi atualizada pela última vez.

domain_names

text

[pt] Domínios de e-mail vinculados à organização.

shared_tickets

boolean

[pt] Permite que usuários da organização vejam os tickets uns dos outros.

name

text

[pt] Nome único da organização.

url

text

[pt] URL do registro da organização.

organization_fields

text

[pt] Campos personalizados armazenados para a organização.

created_at

timestamp

[pt] Quando a organização foi criada.

tags

text

[pt] Tags associadas à organização.

details

text

[pt] Detalhes adicionais sobre a organização (ex.: endereço).

group_id

text

[pt] Grupo atribuído automaticamente a novos tickets desta organização.

external_id

text

[pt] ID externo para vincular a organização a outro sistema (não diferencia maiúsculas/minúsculas).

notes

text

[pt] Anotações internas sobre a organização.

Pesquisas de satisfação (notas)

Tipo de replicacao: Incremental

Avaliações de satisfação de tickets, com solicitante, responsável e datas.

Campo Tipo

id

text

[pt] Identificador único da avaliação de satisfação.

comment

text

[pt] Comentário enviado com a avaliação, quando disponível.

assignee_id

text

[pt] Agente atribuído no momento da avaliação.

score

text

[pt] Valor da avaliação (offered, unoffered, good, bad).

ticket_id

text

[pt] Identificador do ticket avaliado.

    Tickets > > id

requester_id

text

[pt] Solicitante que enviou a avaliação.

url

text

[pt] URL do registro da avaliação.

created_at

timestamp

[pt] Quando a avaliação de satisfação foi criada.

group_id

text

[pt] Grupo atribuído ao ticket no momento da avaliação.

updated_at

timestamp

[pt] Quando a avaliação de satisfação foi atualizada pela última vez.

Tickets

Tipo de replicacao: Incremental

Objeto principal

Tickets do Zendesk com detalhes da requisição, roteamento e vínculos.

Campo Tipo

id

text

[pt] Identificador único do ticket.

status

text

[pt] Status do ticket (new, open, pending, hold, solved, closed).

follower_ids

text

[pt] Identificadores dos agentes que seguem o ticket.

via__source__to__name

text

[pt] Nome do destino nos metadados da origem do ticket.

via__source__to__address

text

[pt] Endereço de destino nos metadados da origem do ticket.

via__source__from__name

text

[pt] Nome da origem capturado para o ticket.

via__source__from__address

text

[pt] Endereço de origem capturado para o ticket.

via__source__rel

text

[pt] Indicador de relação nos metadados da origem do ticket.

via__channel

text

[pt] Canal pelo qual o ticket foi criado.

description

text

[pt] Primeiro comentário/conteúdo do ticket (somente leitura).

tags

text

[pt] Tags aplicadas ao ticket.

problem_id

text

[pt] Para tickets do tipo incidente, ID do ticket de problema relacionado.

allow_channelback

boolean

[pt] Indica se o channelback é permitido para este ticket.

updated_at

timestamp

[pt] Quando o ticket foi atualizado pela última vez.

submitter_id

text

[pt] Usuário que submeteu o ticket (autor do primeiro comentário).

    Usuários > > id

assignee_id

text

[pt] Agente atualmente atribuído ao ticket.

    Usuários > > id

brand_id

text

[pt] Identificador da marca vinculada a este ticket.

due_at

timestamp

[pt] Data/hora de vencimento para tickets do tipo tarefa.

satisfaction_rating

text

[pt] Avaliação de satisfação ou estado (oferecida/não oferecida), quando disponível.

is_public

boolean

[pt] Verdadeiro quando o ticket tem comentários públicos.

requester_id

text

[pt] Usuário que solicitou o ticket.

    Usuários > > id

forum_topic_id

text

[pt] Tópico do fórum de origem do ticket (quando aplicável).

recipient

text

[pt] Endereço do destinatário original usado para notificações.

subject

text

[pt] Título/assunto do ticket.

organization_id

text

[pt] Organização vinculada ao solicitante.

    Organizações > > id

url

text

[pt] URL do registro do ticket.

type

text

[pt] Tipo do ticket (problem, incident, question, task).

created_at

timestamp

[pt] Quando o ticket foi criado.

sharing_agreement_ids

text

[pt] Identificadores de acordos de compartilhamento aplicados ao ticket.

allow_attachments

boolean

[pt] Indica se agentes podem adicionar anexos aos comentários.

followup_ids

text

[pt] IDs de follow-ups criados a partir deste ticket (visíveis após o fechamento).

collaborator_ids

text

[pt] Identificadores dos usuários atualmente em cópia no ticket.

priority

text

[pt] Nível de prioridade (urgent, high, normal, low).

raw_subject

text

[pt] Placeholder de conteúdo dinâmico para o assunto, ou o próprio texto do assunto.

email_cc_ids

text

[pt] IDs de agentes ou usuários finais atualmente em cópia no ticket.

has_incidents

boolean

[pt] Indica se um ticket do tipo problema possui incidentes vinculados.

group_id

text

[pt] Grupo ao qual o ticket está atribuído.

    Grupos > > id

external_id

text

[pt] Identificador externo para vincular o ticket a outro sistema.

zendesk_tickets__fields

Valores de campos personalizados detalhados por ticket.

Campo Tipo

ticket_id

text

[pt] ID do ticket de origem.

fields__id

text

[pt] Identificador do campo do ticket.

fields_title

text

[pt] Título/rótulo do campo.

fields__value

text

[pt] Valor armazenado no campo personalizado.

Usuários

Tipo de replicacao: Incremental

Usuários do Zendesk com dados de perfil, função e acesso.

Campo Tipo

id

text

[pt] Identificador único do usuário.

tags

text

[pt] Tags atribuídas ao usuário quando a marcação está habilitada.

locale

text

[pt] Idioma/região configurados para o usuário.

shared_agent

boolean

[pt] Indica se o agente é compartilhado de outra instância do Zendesk (compartilhamento de tickets).

updated_at

timestamp

[pt] Quando o cadastro do usuário foi atualizado pela última vez.

restricted_agent

boolean

[pt] Indica se o agente possui restrições (falso para admins/agentes sem restrições).

organization_id

text

[pt] Identificador da organização do usuário.

phone

text

[pt] Telefone principal do usuário.

custom_role_id

text

[pt] ID de função personalizada para agentes em planos Enterprise ou superiores.

last_login_at

timestamp

[pt] Data/hora do último acesso autenticado do usuário.

role_type

text

[pt] Tipo numérico de função (0 agente custom, 1 agente light, 2 agente de chat, 3 colaborador de chat, 4 admin, 5 admin financeiro).

default_group_id

text

[pt] Identificador do grupo padrão do usuário.

suspended

boolean

[pt] Indica se o usuário está suspenso; usuários suspensos não podem acessar.

report_csv

boolean

[pt] Permite acesso a relatórios CSV na área de relatórios (apenas planos com esse recurso).

active

boolean

[pt] Indica se o usuário está ativo (não excluído).

two_factor_auth_enabled

boolean

[pt] Indica se a autenticação em duas etapas está habilitada.

notes

text

[pt] Anotações internas armazenadas sobre o usuário.

iana_time_zone

text

[pt] Fuso horário IANA definido para o usuário.

moderator

boolean

[pt] Indica se o usuário pode moderar fóruns.

verified

boolean

[pt] Indica se alguma identidade do usuário está verificada.

name

text

[pt] Nome completo do usuário.

only_private_comments

boolean

[pt] Se verdadeiro, o usuário só pode criar comentários privados.

url

text

[pt] URL para o registro do usuário.

created_at

timestamp

[pt] Quando o cadastro do usuário foi criado.

time_zone

text

[pt] Fuso horário configurado para o usuário.

shared_phone_number

text

[pt] Indica se o número de telefone é compartilhado.

alias

text

[pt] Nome alternativo exibido para usuários finais.

role

text

[pt] Rótulo de função do usuário (end-user, agent, admin).

details

text

[pt] Detalhes adicionais armazenados sobre o usuário (ex.: endereço).

signature

text

[pt] Assinatura configurada para o usuário (somente agentes/admins).

shared

boolean

[pt] Indica se o usuário é compartilhado de outra instância (compartilhamento de tickets).

external_id

text

[pt] Identificador externo de outro sistema (sensível a maiúsculas/minúsculas).

email

text

[pt] E-mail principal do usuário.

chat_only

boolean

[pt] Indica se o usuário é um agente apenas de chat.

ticket_restriction

text

[pt] Escopo de acesso aos tickets (organization, groups, assigned, requested ou null).

Notas

  • Parte desta documentacao foi gerada automaticamente por IA e pode conter erros. Recomendamos verificar informacoes críticas