Zendesk

Visão geral

O Zendesk é uma plataforma de atendimento ao cliente que centraliza tickets de suporte, chat ao vivo e base de conhecimento, facilitando operações de helpdesk eficientes e o engajamento com clientes. Com a integração no SquadOS, seus agentes podem criar e atualizar tickets, gerenciar usuários e organizações, pesquisar conversas e automatizar fluxos de suporte diretamente a partir de outros sistemas ou gatilhos.

• Site oficial: https://www.zendesk.com/
• Documentação na Composio: docs.composio.dev/toolkits/zendesk

Autenticação

Esta ferramenta utiliza OAuth 2.0 (OAUTH2) para conectar.

Você vai precisar dos seguintes campos:

Campo	Obrigatório	Descrição
subdomain	Sim	O subdomínio da sua conta Zendesk (ex.: minhaempresa em minhaempresa.zendesk.com).

Como obter a credencial

1. Acesse zendesk.com e faça login na sua conta.
2. Anote o subdomínio exibido na barra de endereços (a parte antes de .zendesk.com).
3. Na etapa de conexão via Composio, informe esse subdomínio e autorize o acesso quando solicitado.

Dica

Para usar credenciais OAuth personalizadas (app próprio), consulte o guia passo a passo em composio.dev/auth/zendesk.

Como conectar no SquadOS

1. Acesse Ferramentas no menu lateral (/admin/tools).
2. Abra a aba Disponíveis e procure por Zendesk.
3. Clique no card para abrir o modal de detalhes e em Conectar.
4. Você é levado para a página de conexão segura hospedada pela Composio, onde autoriza o acesso via OAuth 2.0.
5. Ao concluir, você volta para o SquadOS com a conta conectada e a ferramenta disponível para os agentes. (Detalhes do fluxo em Ferramentas da Organização.)

Perguntas frequentes

Como configurar credenciais OAuth personalizadas para o Zendesk?

Para um guia passo a passo sobre como criar e configurar suas próprias credenciais OAuth do Zendesk na Composio, consulte Como criar credenciais OAuth para o Zendesk.

Ações disponíveis

Nota

Esta integração expõe 452 ações no total. Abaixo estão as principais; a lista completa está na documentação da Composio.

Criar ticket no Zendesk

ZENDESK_CREATE_ZENDESK_TICKET

Cria um ticket no Zendesk com suporte completo a todos os campos. Retorna ticket_id e ticket_url; use ZENDESK_GET_ZENDESK_TICKET_BY_ID para obter o objeto completo do ticket.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
subject	string	Sim	Resumo curto do problema (ex.: ‘Não consigo fazer login’).
description	string	Sim	Descrição detalhada / passos para reproduzir. Torna-se o comentário inicial do ticket.
status	string	Não	Estado do ticket. Valores permitidos: new, open, pending, hold, solved, closed.
priority	string	Não	Prioridade do Zendesk. Valores: urgent, high, normal, low. Padrão: normal.
ticket_type	string	Não	Tipo do ticket. Valores: problem, incident, question, task.
assignee_id	integer	Não	ID do agente ao qual o ticket será atribuído.
group_id	integer	Não	ID do grupo ao qual o ticket será atribuído.
requester_id	integer	Não	ID do usuário solicitante. Se informado, requester_name e requester_email são ignorados.
requester_name	string	Não	Nome do solicitante. Se fornecido, requester_email também é obrigatório.
requester_email	string	Não	E-mail do solicitante. Deve acompanhar requester_name.
tags	array	Não	Array de tags a aplicar ao ticket.
due_at	string	Não	Data de vencimento em formato ISO 8601. Aplicável apenas a tickets do tipo task.
custom_fields	array	Não	Array de objetos de campos customizados com propriedades id e value.
collaborators	array	Não	Array de colaboradores em CC. Cada elemento pode ser um ID de usuário (inteiro), endereço de e-mail (string) ou objeto com email e name opcional.
collaborator_ids	array	Não	Array de IDs de usuários a adicionar como colaboradores (CCs).
email_ccs	array	Não	Array de objetos de CC por e-mail. Campo write-only para adicionar/remover CCs por e-mail.
followers	array	Não	Array de objetos de seguidores. Campo write-only para adicionar/remover seguidores.
external_id	string	Não	ID externo para vincular o ticket a registros em outro sistema.
ticket_form_id	integer	Não	ID do formulário de ticket. Apenas para contas Enterprise.
via_followup_source_id	integer	Não	ID de um ticket fechado para criar um follow-up. O novo ticket será vinculado ao ticket de origem.
additional_collaborators	array	Não	Array de colaboradores a adicionar em CC sem remover os existentes.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter ticket do Zendesk

ZENDESK_GET_ZENDESK_TICKET_BY_ID

Obtém os detalhes de um ticket do Zendesk. A resposta envolve todos os dados sob uma chave data de nível superior; acesse data['comments'] para comentários e data['comments'][i]['attachments'] para anexos. Cada comentário possui campos html_body e body em texto simples. Campos como subject, organization_id, author_id e body podem ser nulos; trate de forma defensiva.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
ticket_id	integer	Sim	ID do ticket a ser obtido.
page	integer	Não	Número da página para paginação dos comentários do ticket (começa em 1).
per_page	integer	Não	Número de comentários por página (máx. 100).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar ticket do Zendesk

ZENDESK_UPDATE_ZENDESK_TICKET

Atualiza um ticket no Zendesk. Use quando precisar modificar campos como status, prioridade ou assunto após confirmar o ID do ticket.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
ticket_id	integer	Sim	ID do ticket a ser atualizado.
status	string	Não	Categoria de status do ticket. Valores: new, open, pending, hold, solved.
priority	string	Não	Prioridade do ticket. Valores: urgent, high, normal, low. Diferenciam maiúsculas/minúsculas.
subject	string	Não	Assunto/título do ticket a definir na atualização.
assignee_id	integer	Não	ID numérico do agente ao qual o ticket será atribuído.
group_id	integer	Não	ID numérico do grupo ao qual o ticket será atribuído.
comment_body	string	Não	Corpo de texto do comentário a adicionar.
comment_public	boolean	Não	Se o comentário é público (visível ao solicitante) ou interno. Padrão: true.
comment_html_body	string	Não	Corpo HTML do comentário a adicionar.
comment_uploads	array	Não	Tokens de upload para anexar arquivos ao comentário.
comment_author_id	integer	Não	ID do autor do comentário, se diferente do usuário autenticado.
tags	array	Não	Tags a definir no ticket. Substitui todas as tags existentes.
custom_fields	array	Não	Lista de valores de campos customizados. Cada item: {id: number, value: any}.
custom_status_id	integer	Não	ID de um status customizado. Use quando status customizados estiverem ativos em vez do campo status.
due_at	string	Não	Data/hora de vencimento para tickets do tipo task (ISO 8601).
collaborators	array	Não	Colaboradores a definir (substitui os existentes).
collaborator_ids	array	Não	IDs de usuários colaboradores a definir (substitui os existentes).
additional_collaborators	array	Não	Adicionar colaboradores sem remover os existentes.
email_ccs	array	Não	CCs por e-mail a adicionar/remover.
followers	array	Não	Seguidores a adicionar/remover.
safe_update	boolean	Não	Habilitar bloqueio otimista para evitar sobrescritas em colisões. Deve ser combinado com updated_stamp.
updated_stamp	string	Não	Timestamp updated_at mais recente conhecido (ISO 8601) para uso com safe_update.
metadata	object	Não	Metadados customizados a anexar à auditoria desta atualização (até ~1 KB).
data	object	Não	Objeto de atualização bruto do ticket. Forneça para enviar campos sob o wrapper ticket diretamente.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir ticket do Zendesk

ZENDESK_DELETE_ZENDESK_TICKET

Exclui permanentemente um ticket no Zendesk, incluindo todo o histórico de conversas. Esta ação é irreversível; sempre confirme o ticket_id correto antes de executar.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
ticket_id	integer	Sim	ID do ticket a ser excluído.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar tickets recentes

ZENDESK_GET_RECENT_TICKETS

Lista os tickets visualizados recentemente no Zendesk, ordenados pelo horário da última visualização (mais recente primeiro). Útil para agentes acessarem rapidamente tickets em que estavam trabalhando. A paginação é limitada a 10.000 registros (100 páginas × 100 por página).

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
page	integer	Não	Número da página para paginação por offset (1–100).
per_page	integer	Não	Número de tickets por página (máx. 100).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Pesquisar no Zendesk

ZENDESK_SEARCH_ZENDESK

Pesquisa tickets, usuários, organizações e grupos no Zendesk usando sintaxe de consulta. Use quando precisar encontrar recursos usando critérios de busca flexíveis.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
query	string	Sim	String de consulta de pesquisa. Suporta sintaxe Zendesk para filtrar por tipo, status, prioridade, etc. Exemplo: type:ticket status:open priority:urgent ou assignee:me status:pending.
page	integer	Não	Número da página para paginação por offset.
per_page	integer	Não	Número de resultados por página. Padrão: 10, máx.: 100.
sort_by	string	Não	Campo para ordenar os resultados. Opções: updated_at, created_at, priority, status, ticket_type.
sort_order	string	Não	Direção da ordenação. Opções: asc (crescente) ou desc (decrescente).
include	string	Não	Sideloads a incluir na resposta. Requer sintaxe aninhada: tipo_resultado(recurso1,recurso2).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter comentários do ticket

ZENDESK_GET_TICKET_COMMENTS

Lista os comentários de um ticket do Zendesk em ordem cronológica (mais antigo primeiro por padrão). Cada comentário possui campos html_body e plain_body — use plain_body para texto limpo sem HTML. Comentários públicos são visíveis para usuários finais; comentários internos são visíveis apenas para agentes.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
ticket_id	integer	Sim	ID do ticket para recuperar os comentários.
sort_order	string	Não	Ordenação dos comentários. Padrão: asc (mais antigo primeiro). Use desc para mais recente primeiro.
per_page	integer	Não	Número de registros por página (máx. 100).
include	string	Não	Aceita users. Use para listar CCs por e-mail carregando os usuários lateralmente.
include_inline_images	boolean	Não	Quando true, imagens inline também são listadas como anexos na resposta.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Tornar comentário do ticket privado

ZENDESK_MAKE_COMMENT_PRIVATE

Torna um comentário público de ticket privado no Zendesk, alterando a visibilidade de público para interno (somente agentes). Use quando precisar converter um comentário voltado ao cliente em uma nota interna. Apenas agentes podem tornar comentários privados.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
ticket_id	integer	Sim	ID do ticket que contém o comentário a tornar privado.
ticket_comment_id	integer	Sim	ID do comentário do ticket a tornar privado.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar usuário no Zendesk

ZENDESK_CREATE_ZENDESK_USER

Cria um novo usuário no Zendesk. Pesquise usuários existentes primeiro para evitar contas duplicadas com o mesmo e-mail. Use quando precisar cadastrar um usuário com detalhes específicos.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user	object	Sim	Objeto de usuário contendo todos os atributos a criar. name é obrigatório. role deve ser um dos valores: end-user, agent ou admin. organization_id deve ser o ID numérico de uma organização existente.
skip_verify_email	boolean	Não	Se true, não envia e-mail de verificação no momento da criação.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter usuário

ZENDESK_GET_USER

Obtém um único usuário do Zendesk pelo user_id numérico. Use quando tiver o ID de um usuário vindo de payloads de ticket (requester_id, submitter_id, assignee_id, author_id) e precisar de detalhes completos (nome, e-mail, cargo, organization_id, etc.).

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user_id	integer	Sim	ID numérico do usuário Zendesk a recuperar.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar perfil de usuário do Zendesk

ZENDESK_UPDATE_USER_PROFILE

Atualiza parcialmente um perfil de usuário no Zendesk por identificador. Usa semântica de merge patch JSON — apenas os campos fornecidos são atualizados. O identificador deve seguir o formato fonte:tipo:tipo_identificador:valor_identificador.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
identifier	string	Sim	Identificador de perfil no formato fonte:tipo:tipo_identificador:valor_identificador (ex.: company:contact:email:joao@exemplo.com).
name	string	Não	Nome da pessoa a definir no perfil.
type	string	Não	Tipo de perfil (ex.: contact, user, account).
source	string	Não	Sistema/aplicação de origem do perfil (ex.: company). Não pode ser zendesk (reservado).
attributes	object	Não	Objeto com atributos/detalhes do perfil conforme JSON Schema.
identifiers	array	Não	Lista de identificadores do perfil. Cada um deve ter type e value.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Pesquisar usuários do Zendesk

ZENDESK_SEARCH_ZENDESK_USERS

Pesquisa usuários no Zendesk por consulta ou ID externo. Use para encontrar usuários com critérios flexíveis de busca com sintaxe de pesquisa Zendesk (ex.: correspondências parciais de nome, padrões de e-mail, notas, números de telefone).

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
query	string	Não	Suporta sintaxe de pesquisa Zendesk para buscas avançadas de usuário. Pode especificar valor parcial ou completo de qualquer propriedade (nome, e-mail, notas, telefone). Exemplo: query='jdoe'.
external_id	string	Não	Não suporta sintaxe de pesquisa — aceita apenas valores de ID exatos.
page	integer	Não	Número da página para paginação por offset.
per_page	integer	Não	Número de registros por página.
include	string	Não	Lista separada por vírgulas de sideloads a incluir na resposta.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar organização no Zendesk

ZENDESK_CREATE_ZENDESK_ORGANIZATION

Cria uma nova organização no Zendesk. O ID da organização é atribuído automaticamente e retornado. Esta ação é irreversível. Use quando precisar registrar uma nova empresa, cliente ou grupo como organização no Zendesk.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Nome único para a organização. Espaços iniciais e finais são automaticamente removidos.
tags	array	Não	Tags da organização.
notes	string	Não	Observações sobre a organização.
details	string	Não	Detalhes sobre a organização, como endereço.
group_id	integer	Não	Tickets de usuários desta organização são automaticamente atribuídos a este grupo.
external_id	string	Não	ID externo único para associar a organização a um registro externo.
domain_names	array	Não	Array de nomes de domínio associados a esta organização.
shared_tickets	boolean	Não	Usuários finais desta organização podem ver os tickets uns dos outros.
shared_comments	boolean	Não	Usuários finais desta organização podem comentar nos tickets uns dos outros.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter organização do Zendesk

ZENDESK_GET_ZENDESK_ORGANIZATION

Obtém os metadados de uma organização específica do Zendesk pelo ID. Os campos da resposta estão disponíveis em data.organization_info. Não retorna listas de membros/usuários.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
organization_id	integer	Sim	ID numérico da organização a recuperar. Deve ser um inteiro não nulo; converta para int se vier de ferramentas que o retornam como string.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar organizações do Zendesk

ZENDESK_GET_ALL_ZENDESK_ORGANIZATIONS

Obtém todas as organizações no Zendesk. Retorna resultados aninhados em um array organizations; uma lista vazia é válida. Não aceita filtros no servidor — toda filtragem por nome, domain_names ou campos de organização deve ser feita no lado do cliente. Contas grandes requerem paginação.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar organização do Zendesk

ZENDESK_UPDATE_ZENDESK_ORGANIZATION

Atualiza uma organização no Zendesk. Após a atualização, busque novamente via ZENDESK_GET_ZENDESK_ORGANIZATION se a lógica downstream depender dos dados atuais.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
organization_id	integer	Sim	ID da organização a atualizar. Verifique o ID exato antes de atualizar.
data	object	Sim	Novos dados para a organização. Deve usar nomes de campo válidos do Zendesk (ex.: name, notes, domain_names, external_id). domain_names deve ser um array e é tratado como substituição completa — sempre inclua domínios existentes junto com os novos.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Pesquisar organizações

ZENDESK_SEARCH_ZENDESK_ORGANIZATIONS

Pesquisa organizações no Zendesk por ID externo ou nome. Retorna um array de organizações correspondentes aos critérios fornecidos. Um array organizations vazio com count=0 significa que nenhum resultado foi encontrado.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Não	Nome da organização a pesquisar. Suporta correspondência exata e parcial.
external_id	integer	Não	ID externo da organização a pesquisar. Identificador externo insensível a maiúsculas/minúsculas.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar solicitação no Zendesk

ZENDESK_CREATE_ZENDESK_REQUEST

Cria uma nova solicitação no Zendesk. Use quando um usuário final precisar enviar uma solicitação de suporte via API. Retorna a solicitação criada com seu ID e URL.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
subject	string	Sim	Assunto/título da solicitação.
comment_body	string	Não	Descrição inicial ou comentário da solicitação.
priority	string	Não	Prioridade da solicitação. Valores: low, normal, high, urgent. Padrão: normal.
type	string	Não	Tipo da solicitação. Valores: question, incident, problem, task.
status	string	Não	Estado da solicitação. Padrão: new.
tags	array	Não	Array de tags a aplicar à solicitação.
requester_id	integer	Não	ID do usuário que está fazendo a solicitação.
requester_name	string	Não	Nome do solicitante. Se fornecido com requester_email, cria um objeto de usuário.
requester_email	string	Não	E-mail do solicitante. Deve ser fornecido junto com requester_name.
external_id	string	Não	ID externo para vincular a solicitação a registros em outro sistema.
custom_fields	array	Não	Campos customizados. Cada item deve incluir id e value.
ticket_form_id	integer	Não	ID numérico do formulário de ticket. Aplicável apenas para contas Enterprise.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Executar visualização

ZENDESK_GET_VIEWS_EXECUTE

Executa uma visualização salva do Zendesk para recuperar os títulos das colunas e as linhas de tickets correspondentes. Suporta paginação, ordenação personalizada e agrupamento opcional de resultados.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
view_id	integer	Sim	ID da visualização a executar.
sort_by	string	Não	Campo de ticket para ordenação (título ou ID de campo customizado).
sort_order	string	Não	Direção da ordenação. Valores: asc ou desc.
group_by	string	Não	Campo de ticket para agrupamento.
page	string	Não	Parâmetro de paginação. Suporta paginação tradicional por offset e baseada em cursor.
include	string	Não	Lista separada por vírgulas de sideloads a incluir na resposta.
exclude	string	Não	Lista separada por vírgulas de sideloads a excluir da resposta.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Fazer upload de anexo no Zendesk

ZENDESK_CREATE_ZENDESK_ATTACHMENTS

Faz upload de um arquivo de anexo para o Zendesk. Retorna um objeto de anexo com um ID que pode ser usado para vincular o arquivo a um comentário de ticket. O token de upload retornado é válido por 60 minutos.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
file	object	Sim	O arquivo a fazer upload para o Zendesk. Objeto FileUploadable onde name é o nome do arquivo a usar como anexo (ex.: documento.pdf, log_erro.txt).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar grupo no Zendesk

ZENDESK_CREATE_ZENDESK_GROUP

Cria um novo grupo no Zendesk. O nome do grupo deve ser único na conta. Use para organizar agentes em equipes para atribuição e roteamento de tickets. Retorna o objeto completo do grupo incluindo o ID atribuído.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Nome do grupo. Deve ser único na conta. Espaços iniciais/finais são removidos.
description	string	Não	Descrição opcional do grupo explicando seu propósito ou responsabilidades.
is_public	boolean	Não	Se true, o grupo é público e visível para todos os agentes. Se false, o grupo é privado. Não é possível mudar de privado para público após a criação.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Pré-visualizar macro do Zendesk

ZENDESK_APPLY_ZENDESK_MACRO

Pré-visualiza como uma macro do Zendesk afetaria um ticket sem aplicá-la de fato. Retorna o objeto do ticket como apareceria após a aplicação da macro, mostrando quaisquer alterações em campos, comentários, status ou outras propriedades.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
ticket_id	integer	Sim	ID do ticket para pré-visualizar a macro.
macro_id	integer	Sim	ID da macro a aplicar.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar macros

ZENDESK_GET_MACROS

Lista todas as macros compartilhadas e pessoais disponíveis na sua conta Zendesk. Macros são modelos de resposta salvos que os agentes podem aplicar a tickets. Suporta filtragem por nível de acesso, status ativo, categoria e grupo.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
active	boolean	Não	Filtrar por macros ativas (true) ou inativas (false).
access	string	Não	Filtrar por acesso. Valores: personal, agents, shared, account.
sort_by	string	Não	Ordenação dos resultados. Valores: alphabetical, created_at, updated_at, usage_1h, usage_24h, usage_7d, usage_30d.
sort_order	string	Não	Direção da ordenação. Valores: asc ou desc.
group_id	integer	Não	Filtrar macros por ID de grupo.
category	integer	Não	Filtrar macros por ID de categoria.
only_viewable	boolean	Não	Se true, retorna apenas macros que podem ser aplicadas a tickets.
page	string	Não	Parâmetro de paginação. Suporta paginação por offset e baseada em cursor.
per_page	integer	Não	Número de registros por página.
include	string	Não	Sideload a incluir na resposta.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter informações sobre mim no Zendesk

ZENDESK_GET_ABOUT_ME

Obtém informações sobre o usuário atualmente autenticado no Zendesk. Retorna apenas os dados da própria conta do chamador; para consultar outros usuários, use ZENDESK_SEARCH_ZENDESK_USERS. A resposta aninha o objeto de usuário em data.owner_info.user. Útil para verificar a identidade e as permissões do usuário atuante antes de realizar operações em lote.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.