Criação de webhooks na Central de administração

Caminho rápido: Central de administração > Aplicativos e integrações > Webhooks > Webhooks

Um webhook envia uma solicitação HTTP para uma URL específica em resposta a um evento, como o acionamento de um gatilho ou uma automação no Zendesk Support. Os desenvolvedores da web normalmente usam webhooks para invocar um comportamento em outro sistema.

Você precisa ser um administrador ou um agente em uma função personalizada com permissão para criar webhooks.

Observação: as contas de avaliação têm um limite de, no máximo, dez webhooks.

Este artigo abrange os seguintes tópicos:

Sobre webhooks
Criação de webhooks
Teste de um webhook

Sobre webhooks

Os webhooks servem para integrar serviços de terceiros ou seu sistema back-end. Por exemplo, você pode usar webhooks para:

Alertar sua equipe no Slack quando um ticket urgente for criado
Encaminhar detalhes do ticket para sua equipe de documentação no Asana depois que um ticket for resolvido
Notificar seu próprio serviço back-end sobre um evento de ticket importante.

Você pode usar os webhooks para passar informações para serviços de terceiros e REST APIs que aceitem conteúdo JSON, XML ou formulário codificado nas solicitações HTTP. Você também pode usar os webhooks para passar os parâmetros da URL para qualquer URL.

Os webhooks são usados por automações e gatilhos no Zendesk Support quando um ticket atende a condições específicas. Os webhooks são importantes, pois são o meio usado por gatilhos e automações para gerar ações com base em respostas HTTP de serviços de terceiros.

Você pode usar qualquer um dos placeholders do conteúdo disponíveis para inserir dados de ticket nas solicitações HTTP.

Quando uma regra de negócios aciona um webhook, ela coloca a tarefa de webhook na fila de execução, mas não a executa imediatamente. Como as tarefas do webhook são executadas de maneira independente, não há garantia de que a execução vá seguir uma determinada ordem.

As solicitações do webhook serão tentadas novamente de forma automática por três vezes se o ponto de extremidade retornar alguns códigos de resposta HTTP. Diferentemente de alvos, as solicitações com falhas consecutivas não desativam webhooks. Para obter mais informações e exemplos sobre cenários de novas tentativas, consulte Gerenciamento de webhooks na documentação do desenvolvedor.

Criação de webhooks

Para criar um webhook, é necessário executar duas partes. Primeiramente, você define os detalhes do próprio webhook. Em seguida, você o anexa a um gatilho ou a uma automação para que ele possa ser usado.

Observação: ao configurar um webhook para se integrar a serviços de terceiros, consulte a documentação desse terceiro.

Como criar um webhook

Na Central de administração, clique em Aplicativos e integrações na barra lateral e selecione Webhooks > Webhooks.
Clique em Ações e selecione Criar webhook.
Configure o webhook para integração com o serviço de terceiros ou o sistema.
Para obter mais informações, consulte Pontos de extremidades de webhook e Autenticação de seu webhook.
(Opcional) Clique em Testar webhook para garantir que ele esteja funcionando conforme o esperado.
Clique em Avançar para conectar o webhook a um gatilho ou uma automação do Support. Essa ação é executada na interface do administrador do Zendesk Support.
Retorne para a página Criar webhook na Central de administração e clique em Concluir configuração.

Após você criar um webhook e conectá-lo a um gatilho ou uma automação, poderá visualizar os detalhes do webhook, as assinaturas do evento e a atividade, tudo na página Webhooks na Central de administração. Para obter mais informações, consulte Gerenciamento de webhooks na Central de administração.

Pontos de extremidade do webhook

Os webhooks enviam solicitações e recebem respostas da URL do ponto de extremidade que você especifica no momento da criação deles. É dessa forma que eles se integram a serviços de terceiros, APIs e sistemas.

A URL do ponto de extremidade usa este formato: https://www.yourdomain.com/path.

Apesar de não ser obrigatório, recomendamos o uso de HTTP Seguro (HTTPS). Ao fornecer uma URL do ponto de extremidade segura, você ativa a autenticação e pode passar dados de forma segura.

Autenticação do webhook

Se o seu webhook está se integrando a um ponto de extremidade seguro, você tem três opções para autenticar o webhook e os dados que ele envia. Talvez seja interessante consultar a documentação de terceiros sobre os requisitos de autenticação do ponto de extremidade ou trabalhar com um desenvolvedor de sua equipe para definir o método de autenticação correto para o seu webhook.

Não é necessária – nenhuma autenticação é obrigatória ou está configurada.
Autenticação básica – usa o nome de usuário e a senha para autenticar o webhook.
Token do portador – usa o token de acesso OAuth para autenticar o webhook.

Se seus desenvolvedores desejam obter mais informações sobre autenticação e segurança de webhooks, consulte a documentação sobre segurança e autenticação de webhooks.

Conexão de um webhook a um gatilho ou uma automação

Para o webhook entrar em ação, ele precisa estar conectado a um gatilho ou uma automação. Os gatilhos e as automações especificam as circunstâncias sob as quais o webhook deve ser invocado.

Como conectar um webhook a um gatilho do Support

Na Central de administração, clique em Objetos e regras na barra lateral e selecione Regras de negócios > Gatilhos.
Observação: se você está criando ou editando um webhook, clique em Gerenciar regras de negócios.
Crie um novo gatilho ou edite um existente passando o cursor do mouse sobre o ícone de opções () e clicando em Editar.
Para gatilhos, em Ações, clique em Adicionar ação. Selecione Notificar webhook e escolha o seu webhook. Clique em Salvar.

Como conectar um webhook a uma automação do Support

Na Central de administração, clique em Objetos e regras na barra lateral e selecione Regras de negócios > Automações.
Observação: se você está criando ou editando um webhook, clique em Gerenciar regras de negócios.
Crie uma nova automação ou edite uma existente passando o cursor do mouse sobre o ícone de opções () e clicando em Editar.
Para automações, em Execute estas ações:, clique no ícone de adicionar ação (). Selecione Notificações: Notificar webhook e também o seu webhook. Clique em Enviar.

Teste de um webhook

Na Central de administração, você pode testar o webhook com diferentes origens de evento e solicitações. Além de acessar os webhooks existentes especificamente para fins de teste, você também pode testar o webhook durante a criação ou a edição.

Como testar um webhook

Na Central de administração, clique em Aplicativos e integrações na barra lateral e selecione Webhooks > Webhooks.
Encontre o webhook na lista, clique no ícone de menu de opções () na linha do webhook e clique em Testar webhook.
No painel Testar webhook, selecione Testar origem do evento. Esse é um gatilho conectado ou ticket de exemplo que você pode usar para testar a URL do ponto de extremidade.
Insira os detalhes da solicitação de teste: corpo da solicitação, parâmetros ou cabeçalhos.
Clique em Enviar teste. A resposta é exibida no painel abaixo de sua solicitação de teste.