Os placeholders do Zendesk Support são recipientes para dados de ticket, usuário e personalizados que são gerados dinamicamente. O formato é uma referência de dados contida entre chaves duplas. Como também é possível acessar dados de ticket, usuário e personalizados quando define a lógica de programação, pode ser útil pensar além dos placeholders e pensar em objetos de dados e suas propriedades, que podem ser usados para ambos os propósitos.
Há dois objetos de dados principais no Zendesk Support: Ticket e Usuário. Cada um possui seu próprio conjunto de propriedades. O objeto Usuário, por exemplo, contém as propriedades do usuário como nome e e-mail. Além destes dois, há os objetos de dados associados. Para os tickets, há os objetos Comentário e Índice de satisfação. Para os usuários, há os objetos Organização e Agente. Também existem objetos personalizados, que são definidos pelos usuários e podem ser associados a tickets, usuários e outros objetos do Zendesk.
Apesar de os placeholders poderem estar em formato de HTML, quando um placeholder é enviado a um alvo da URL ou um webhook, o texto não formatado é usado para renderizar o placeholder, não o HTML. Além disso, os placeholders não funcionam em blocos de código.
Observação: se você oferece suporte a vários idiomas, na maioria dos casos, os valores do placeholder correspondem ao idioma do solicitante no ticket. Essa tradução automática não pode ser desativada.
O Support inclui regras predefinidas do sistema que desativam os placeholders em gatilhos de ticket em algumas situações. As regras predefinidas do sistema são regras que não podem ser alteradas, modificadas nem substituídas, e que ditam o comportamento padrão do Support. Essas regras podem passar a impressão de que os placeholders nos gatilhos de ticket não funcionaram, mas isso não se trata de um erro. Essas regras têm o objetivo de proteger você de spammers que podem usar sua conta para distribuir mensagens de spam. Para obter mais informações, consulte Noções básicas sobre as regras de supressão de placeholders.
Esse artigo categoriza os placeholders pelos dados que exibem. Ao especificar placeholders, lembre-se de que eles diferenciam maiúsculas de minúsculas.
- Dados do usuário
- Dados da organização
- Dados do agente
- Dados do ticket
- Dados do comentário
- Dados de índice de satisfação
- Dados de objeto personalizado
Artigos relacionados:
Dados do usuário
No contexto de atualização de um ticket, há diferentes tipos de usuários. Eles incluem:
- ticket.requester, que é o solicitante do ticket
- ticket.assignee, que é o agente atribuído ao ticket
- ticket.submitter, que é o usuário que enviou a solicitação ou o agente que abriu o ticket em nome do solicitante
- current_user, que é o usuário que está atualizando o ticket no momento (usuário final, agente ou Zendesk como o usuário do sistema)
Isso significa que a maior parte dos dados do usuário listados na tabela a seguir podem ser retornados para cada tipo de usuário (por exemplo, {{ticket.submitter.name}}, {{current_user.name}} e assim por diante).
| Propriedades/placeholders | Descrição |
|---|---|
|
usuário.name
Importante: lembre-se de substituir usuário por um dos tipos de usuário mostrados acima (por exemplo, ticket.requester).
|
O nome completo do usuário. |
| usuário.first_name | O nome do usuário. |
| usuário.last_name | O sobrenome do usuário. |
| usuário.email | O endereço de e-mail do usuário. |
| usuário.language | A preferência de idioma do usuário. |
| usuário.phone | O número de telefone do usuário. |
| usuário.external_id | A ID externa do usuário (se uma existir). Opcional para contas com o single sign-on corporativo com JWT ou SAML habilitado. |
| usuário.details | Os detalhes do usuário. |
| usuário.notes | As observações do usuário. |
| usuário.time_zone | O fuso horário do usuário. |
| usuário.role | A função do usuário (administrador, agente ou usuário final). |
| usuário.extended_role | Ao utilizar as funções de agente do Support no plano Enterprise, isso retorna o nome da função do agente no Enterprise. Estas são as funções predefinidas:
Se você criou funções personalizadas de agentes, esses nomes de funções são retornados. Se você não possui uma conta Enterprise, o uso deste placeholder retorna "Agent" para todos os usuários agentes e "End user" para todos os usuários finais. Para obter mais informações sobre funções personalizadas de agente, consulte Criação de funções personalizadas de agentes e sua atribuição a agentes. |
| usuário.id | A ID do usuário. |
| usuário.locale | A localidade do usuário (por exemplo: en-US). |
| usuário.signature | A assinatura do agente. Apenas agentes possuem assinaturas. |
| usuário.organization... | Consulte Dados da organização a seguir. |
| usuário.tags | Tags. Consulte Inclusão de tags em usuários e organizações. |
| user.custom_fields.<chave_do_campo> | Formato de propriedade/placeholder para o valor dos campos personalizados de um usuário (exceto campos de lista suspensa). Por exemplo, {{ticket.requester.custom_fields.my_custom_field}}. Consulte Inclusão de campos personalizados aos usuários. |
| user.custom_fields.<chave_do_campo>.id | A ID do registro-alvo em um campo de relacionamento de pesquisa. |
| user.custom_fields.<chave_do_campo>.title | Formato de propriedade/placeholder para o valor de um campo personalizado de lista suspensa do usuário. Por exemplo, {{ticket.requester.custom_fields.manager_for_approval.title}}. Consulte Inclusão de campos personalizados aos usuários. |
Sobre placeholders de nome do usuário
o comportamento dos placeholders do nome e do sobrenome depende da formatação do nome no perfil. Por exemplo, se você usar o nome Dutch van der Linde, o placeholder user.last_name exibirá ''Linde''. Agora se usar o nome van der Linde, Dutch no perfil, o placeholder user.last_name exibirá ''van der Linde''.
Além disso, no Japão, o placeholder do nome se refere ao sobrenome do usuário, já o placeholder do sobrenome se refere ao nome do usuário.
Dados da organização
Cada tipo de usuário pode ser adicionado a uma organização. Uma organização possui as seguintes propriedades de dados.
| Propriedades/placeholders | Descrição |
|---|---|
|
usuário.organization.id
Importante: lembre-se de substituir usuário por um dos tipos de usuário mostrados a seguir.
|
A ID da organização à qual o usuário é atribuído. |
| usuário.organization.name | O nome da organização à qual o usuário é atribuído. |
| usuário.organization.is_shared | True ou False (Verdadeiro ou falso). Indica se a organização é uma organização compartilhada. |
| usuário.organization.is_shared_comments | True ou False (Verdadeiro ou falso). Indica se a organização permite que os usuários adicionem comentários aos tickets de outros usuários. |
| usuário.organization.details | Detalhes sobre a organização. |
| usuário.organization.notes | Observações sobre a organização. |
| usuário.organization.tags | Tags. Consulte Inclusão de tags em usuários e organizações. |
Como todos os usuários podem ser adicionados a organizações, você pode acessar os dados da organização para cada uma usando a marcação Liquid. Por exemplo, você pode retornar os dados para cada um dos tipos de usuários (mostrados aqui como placeholders):
- {{ticket.organization.name}}, que é a organização do solicitante do ticket
- {{ticket.requester.organization.name}}, que é igual a {{ticket.organization.name}} (o solicitante)
- {{current_user.organization.name}}, que é o usuário que está atualizando o ticket no momento (usuário final ou agente)
- {{ticket.assignee.organization.name}}, que é o agente atribuído ao ticket
- {{ticket.submitter.organization.name}}, que é o usuário que enviou a solicitação ou o agente que abriu o ticket em nome do solicitante
Dados do agente
Você pode usar os seguintes placeholders apenas em assinaturas de agentes. Para obter mais informações sobre assinaturas de agente, consulte Inclusão de uma assinatura de agente em notificações de e-mail de tickets.
| Propriedades/placeholders | Descrição |
|---|---|
| agent.name | O nome completo do agente (ou alias, se houver). |
| agent.first_name | O nome do agente. |
| agent.last_name | O sobrenome do agente. |
| agent.role | A função do agente. |
| agent.signature | A assinatura do agente. |
| agent.email | O endereço de e-mail do agente. |
| agent.phone | O número de telefone do agente. |
| agent.organization | A organização do agente. |
| agent.language | O idioma do agente. |
| agent.time_zone | O fuso horário do agente. |
Dados do ticket
Os tickets do Zendesk Support contêm as propriedades de dados a seguir:
| Propriedades/placeholders | Descrição |
|---|---|
| ticket.account | O nome da conta do Zendesk. |
| ticket.assignee.name | Nome completo do atribuído do ticket (se houver). Consulte Dados do usuário acima. |
| ticket.brand.name | O nome da marca do ticket. |
| ticket.cc_names | Retorna os nomes dos CCs no ticket.
Observação: se você está usando a nova experiência de CCs e seguidores e está adicionando ou atualizando seus placeholders, recomendamos o uso de
ticket.email_cc_names em vez de tickets.cc_names. Ambos fazem a mesma coisa.Se você quiser que os endereços de e-mail das pessoas em cópia sejam exibidos, use este código Liquid: |
| ticket.email_cc_names |
Com a nova experiência de CCs e seguidores, retorna os nomes dos CCs no ticket. Com a experiência de CCs antiga, retorna vazio.
Observação: se você está usando a nova experiência de CCs e seguidores e está adicionando ou atualizando seus placeholders, recomendamos o uso de
ticket.email_cc_names em vez de tickets.cc_names. Ambos fazem a mesma coisa. |
| ticket.follower_names | Com a nova experiência de CCs e seguidores, retorna os nomes dos seguidores. Com a experiência de CCs antiga, retorna vazio. |
| ticket.follower_reply_type_message | Com a nova experiência de CCs e seguidores, indica que tipo de comentário (público ou privado) acionou a notificação. Faz com que a frase "Responda este e-mail para adicionar um comentário à solicitação" ou "Responda este e-mail para adicionar uma observação interna à solicitação" seja exibida nas notificações por e-mail (consulte Personalização de notificações por e-mail para CCs e seguidores).
Com a experiência de CCs antiga, retorna vazio. |
| ticket.created_at | Data da criação do ticket (por exemplo: 18 de maio de 2014).
Observação: o ano não é incluído se o ticket foi criado no ano atual.
|
| ticket.created_at_with_timestamp | A hora em que o ticket foi criado, expressa como data/hora em formato iso8601. Exemplo: 2013-12-12T05:35Z, que é traduzido como 12 de dezembro, 2013 às 05:35am UTC. |
| ticket.created_at_with_time | Data e hora em que o ticket foi criado. Por exemplo, 10 de fevereiro, 14:29. |
| ticket.current_holiday_name | Se o placeholder é usado fora de um feriado, ele é nulo. Se é usado no feriado, o nome do feriado é exibido. Se você já definiu várias programações, o placeholder respeitará a lista de feriados definida na programação aplicada àquele ticket. |
| ticket.description | Descrição do ticket. Inclui o nome do agente, a data do comentário e a descrição do ticket (o primeiro comentário).
Observação: se o campo do assunto está vazio ou não visível para o solicitante, então esse primeiro comentário será usado e enviado ao solicitante. Isso também é verdadeiro para tickets privados.
|
| ticket.due_date | A data de vencimento do ticket (relevante para tickets do tipo Tarefa). O formato é: Maio-18. |
| ticket.due_date_with_timestamp | A data de vencimento do ticket (relevante para tickets do tipo Tarefa), expressa como data/hora em formato iso8601. Exemplo: 2013-12-12T05:35+0100, que é traduzido como 12 de dezembro, 2013 às 06:35am UTC+1. |
| ticket.external_id | A ID externa do ticket (se uma existir). |
| ticket.encoded_id | A ID codificada é usada para criar conversas com as respostas de e-mail recebidas em tickets existentes. |
| ticket.group.name | O grupo atribuído ao ticket. |
| ticket.id | A ID do ticket #{{ticket.id}} cria um link clicável. {{ticket.id}} renderiza o número do ticket em texto sem formatação. |
| ticket.in_business_hours | True ou False (Verdadeiro ou falso). Verdadeiro se a atualização do ticket foi no horário de operação. Consulte Definição do horário de operação. |
| ticket.link | Caminho completo da URL para o ticket. |
| ticket.organization.custom_fields.<chave_do_campo> | Formato de propriedade/placeholder para campos de organização personalizados. Consulte Inclusão de campos personalizados às organizações. |
| ticket.organization.custom_fields.<chave_do_campo>.id | A ID do registro-alvo em um campo de relacionamento de pesquisa. |
| ticket.organization.custom_fields.<chave_do_campo>.title | Formato de propriedade/placeholder para o valor de um campo personalizado de lista suspensa da organização. Consulte Inclusão de campos personalizados às organizações. |
| ticket.organization.external_id | A ID externa da organização do solicitante do ticket. |
| ticket.organization.id | A ID da organização do solicitante do ticket. |
| ticket.organization.name | Consulte Dados da organização acima. |
| ticket.priority | A prioridade do ticket (Baixa, Normal, Alta, Urgente). |
| ticket.requester.first_name | Primeiro nome do solicitante do ticket.
Se você tem uma instância aberta do Zendesk Support, esse placeholder pode ser alvo de spam em gatilhos de primeira resposta. Consulte Uso de recursos específicos do Zendesk Support contra spam. |
| ticket.requester.last_name | Sobrenome do solicitante do ticket.
Se você tem uma instância aberta do Zendesk Support, esse placeholder pode ser alvo de spam em gatilhos de primeira resposta. Consulte Uso de recursos específicos do Zendesk Support contra spam. |
| ticket.requester.name | Nome completo do solicitante do ticket.
Se você tem uma instância aberta do Zendesk Support, esse placeholder pode ser alvo de spam em gatilhos de primeira resposta. Consulte Uso de recursos específicos do Zendesk Support contra spam. |
| ticket.requester.email | Endereço de e-mail do solicitante do ticket. |
| ticket.requester.custom_fields.<chave_do_campo> | Formato de propriedade/placeholder para campos de usuário personalizados. Por exemplo, {{ticket.requester.custom_fields.my_custom_field}}. Consulte Inclusão de campos personalizados aos usuários. |
| ticket.requester.custom_fields.<chave_do_campo>.id | A ID do registro-alvo em um campo de relacionamento de pesquisa. |
| ticket.requester.custom_fields.<chave_do_campo>.title | Formato de propriedade/placeholder para o valor de um campo personalizado de lista suspensa do usuário. Por exemplo, {{ticket.requester.custom_fields.manager_for_approval.title}}. Consulte Inclusão de campos personalizados às organizações. |
| ticket.requester.details | Os conteúdos do campo Detalhes no perfil de usuário do solicitante. |
| ticket.status | O status padrão do ticket (Novo, Aberto, Pendente, Em espera, Resolvido ou Fechado).
Observação: se você ativou os status personalizados de ticket, esse placeholder exibe o mesmo valor que
{{ticket.status_category}}. |
| ticket.status_category | Se os status personalizados de ticket estiverem ativados, retorna a categoria à qual o status do ticket pertence (Novo, Aberto, Pendente, Em espera, Resolvido, Fechado). Saiba mais sobre as categorias de status do ticket. |
| ticket.custom_status | Se os status personalizados de tickets estiverem ativados, retorna o status personalizado de ticket. |
| ticket.tags | Todas as tags anexadas ao ticket. |
| ticket.ticket_field_<número da ID do campo> | Formato de propriedade/placeholder para campos personalizados. Por exemplo, {{ticket.ticket_field_123}}. Consulte Placeholders para campos personalizados. |
| ticket.ticket_field_<número da ID do campo>.id | A ID do registro-alvo em um campo de relacionamento de pesquisa. |
| ticket.ticket_field_option_title_<número da ID do campo> | Formato de propriedade/placeholder para o valor de um campo personalizado de lista suspensa. Por exemplo, {{ticket.ticket_field_option_title_456}}. Consulte Placeholders para campos personalizados. |
| ticket.ticket_form | Nome do formulário para usuários finais. |
| ticket.ticket_type | Tipo de ticket (Pergunta, Incidente, Problema, Tarefa). Se o tipo de ticket não for especificado, o placeholder retornará "Ticket". |
| ticket.title | O assunto do ticket. Os usuários finais podem ver textos diferentes neste campo. Para obter informações de resolução de problemas sobre esse placeholder, consulte O placeholder ticket.title exibe o primeiro comentário em vez do assunto e Por que a linha de assunto em minhas notificações por e-mail diz “Ticket sem título”.
Se você tem uma instância aberta do Zendesk Support, esse placeholder pode ser alvo de spam em gatilhos de primeira resposta. Consulte Uso de recursos específicos do Zendesk Support contra spam. |
| ticket.updated_at | A data da última atualização do ticket (por exemplo, Maio18). |
| ticket.updated_at_with_time | Data e horário em que o ticket foi atualizado pela última vez. Por exemplo, 10 de fevereiro, 14:29. |
| ticket.updated_at_with_timestamp | A hora em que o ticket foi atualizado pela última vez, expressa como data/hora em formato iso8601. Exemplo: 2013-12-12T05:35Z, que é traduzido como 12 de dezembro, 2013 às 05:35am UTC. |
| ticket.url | O caminho completo da URL para o ticket (exceto "http://"). |
| ticket.verbatim_description | O texto sem formatação da descrição do ticket (o primeiro comentário). Se a opção Incluir anexos em e-mails estiver ativada, os anexos serão incluídos.
Observação: esse placeholder não pode ser usado para enviar anexos em um webhook.
|
| ticket.via | O tipo de origem do ticket (formulário web, e-mail etc.). |
| account.incoming_phone_number_ID | Número de telefone de recebimento de chamadas do Zendesk Talk. Por exemplo, {{account.incoming_phone_number_123}}. |
Dados do comentário
Por serem adicionados aos tickets, os comentários são acessados com o objeto de dados do ticket. Existem quatro tipos de placeholders de comentário:
- Placeholders de comentário HTML são usados para conversas simplificadas de e-mail em aplicativos de e-mail, como o Gmail. Para obter os melhores resultados, eles não devem ser usados com outros placeholders de comentário. Consulte Noções básicas sobre a conversa simplificada de e-mail e Implementação da conversa simplificada de e-mail para aplicativos de e-mail.
-
Placeholders de comentário padrão permitem que você use hashes da linguagem Liquid para escolher o que deseja exibir e retornar uma coleção de dados de anexos e comentários. Por exemplo, é possível configurar modelos para iterar os comentários usando
{{ticket.comments}}. -
Placeholders de comentário formatados permitem retornar representações em HTML renderizadas e pré-formatadas dos placeholders padrão, mas sem muita personalização. Elas simplesmente retornam comentários em formatos predefinidos. Por exemplo,
{{ticket.comments_formatted}}retorna um pequeno pedaço de HTML renderizado. Os comentários de ticket incluem datas, autor, avatar do autor e afins. - Placeholders de comentário em formato rich text permitem que você use rich text em seu modelo personalizado (como acontece com os placeholders de objeto formatados) sem se restringir a regras de formatação predefinidas, para que você tenha mais controle sobre a aparência das notificações. Os objetos de rich text permitem a inclusão de anexos apenas se a opção Incluir anexos em e-mails estiver ativada.
Considerações:
- se você tem CCs ativados, lembre-se de que as notificações por e-mail para quem está em cópia incluem apenas comentários públicos, mesmo para agentes em cópia. Consulte Noções básicas sobre como as notificações por e-mail são enviadas para CCs por padrão.
- Se você usa placeholders de comentário em conversas paralelas, somente comentários públicos são incluídos. Os placeholders de comentário usados em conversas paralelas não retornam observações internas.
| Propriedades/placeholders | Descrição |
|---|---|
| ticket.latest_comment_html | O comentário mais recente incluindo quaisquer anexos. Os agentes recebem o comentário público ou privado mais recente. Os usuários finais recebem o comentário público mais recente. |
| ticket.latest_public_comment_html | O comentário público mais recente, excluindo quaisquer anexos. |
| Propriedades/placeholders | Descrição |
|---|---|
| ticket.comments | Usado como placeholder, {{ticket.comments}} exibe todos os comentários em um ticket em texto não formatado.
Observação: os agentes receberão comentários públicos e observações internas, mas os usuários finais receberão apenas comentários públicos.
Ticket.comments também serve para coletar detalhes de comentários e de anexos. É possível acessar os seguintes dados usando a marcação Liquid:
Para obter um exemplo de como acessar esses dados em regras de negócios, consulte Personalização do formato e o posicionamento do texto em comentários e notificação por e-mail.
Observação: essa mesma coleção de dados de comentário está disponível ao usar os placeholders ticket.public_comments, ticket.latest_comment e ticket.latest_public_comment.
|
| ticket.public_comments | Todos os comentários públicos, os mais recentes primeiro. Texto não formatado. |
| ticket.latest_comment | O comentário mais recente. Texto não formatado. Não inclui anexos, a menos que Incluir anexos em e-mails esteja ativado. Para retornar anexos, use ticket.latest_comment_formatted.
Observação: os agentes receberão o comentário público ou a observação interna mais recente, mas os usuários finais receberão apenas o comentário público mais recente.
|
| ticket.latest_public_comment | O comentário público mais recente. Texto não formatado. |
| Propriedades/placeholders | Descrição |
|---|---|
| ticket.comments_formatted | Todos os comentários, os mais recentes primeiro.
Observação: os agentes receberão comentários públicos e observações internas, mas os usuários finais receberão apenas comentários públicos.
|
| ticket.public_comments_formatted | Todos os comentários públicos, os mais recentes primeiro. |
| ticket.latest_comment_formatted | O comentário mais recente incluindo quaisquer anexos.
Observação: os agentes receberão o comentário público ou a observação interna mais recente, mas os usuários finais receberão apenas o comentário público mais recente.
|
| ticket.latest_public_comment_formatted | O comentário público mais recente. |
| Propriedades/placeholders | Descrição |
|---|---|
| ticket.latest_comment_rich |
O comentário mais recente. Formatação em rich text. Se a opção Incluir anexos em e-mails estiver ativada, os anexos serão incluídos.
Observação: os agentes receberão o comentário público ou a observação interna mais recente, mas os usuários finais receberão apenas o comentário público mais recente.
|
| ticket.latest_public_comment_rich | O comentário público mais recente. Formatação em rich text. Se a opção Incluir anexos em e-mails estiver ativada, os anexos serão incluídos. |
Observação: em algumas circunstâncias, os placeholders de comentários são suprimidos para solicitações de notificações por e-mail e elas não são recebidas.
Dados de índice de satisfação
No Suite Growth e superior ou Support Professional e Enterprise, as propriedades de dados a seguir estão disponíveis para índices de satisfação do cliente (consulte Uso de índices de satisfação do cliente).
Observação: se você suspeita que os índices de satisfação estejam sendo fornecidos por usuários que não são o solicitante, você pode usar placeholders de índice de satisfação fora das regras de negócios. Isso permite que outros usuários enviem índices de satisfação para o solicitante.
| Propriedades | Descrição |
|---|---|
| satisfaction.rating_section | Um bloco de texto formatado que solicita que o usuário classifique sua satisfação. |
| satisfaction.rating_url | Uma URL para classificar o suporte. |
| satisfaction.current_rating | O texto da classificação de satisfação atual (exemplo: “Bom, estou satisfeito”). |
| satisfaction.positive_rating_url | Uma URL para classificar positivamente o suporte. |
| satisfaction.negative_rating_url | Uma URL para classificar negativamente o suporte. |
| satisfaction.current_comment | O comentário adicionado pelo usuário ao classificar um ticket. |
Dados de objeto personalizado
Em todos os planos do Zendesk Suite e do Support Enterprise, as seguintes propriedades de dados estão disponíveis para os objetos personalizados. Estes placeholders têm suporte para gatilhos de objeto.
| Propriedades | Descrição |
|---|---|
| custom_objects.<chave_do_objeto>.custom_fields.<chave_do_campo> | O valor do campo de um objeto personalizado. |
| custom_objects.<chave_do_objeto>.custom_fields.<chave_do_campo>.title | O valor de um campo de lista suspensa. |
| custom_objects.<chave_do_objeto>.custom_fields.<chave_do_campo>.id | O ID do objeto-alvo em um campo de relacionamento de pesquisa. |
| custom_objects.<chave_do_objeto>.custom_fields.<chave_do_campo>.name | O nome do campo de relacionamento de pesquisa. |
| custom_objects.<chave_do_objeto>.external_id | O ID externo do registro de objeto personalizado. |
| custom_objects.<chave_do_objeto>.id | O ID do registro de objeto personalizado. |
| custom_objects.<chave_do_objeto>.name | O nome do registro de objeto personalizado. |