Gerenciamento de webhooks

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

Os webhooks são criados e gerenciados na Central de administração do Zendesk na página Webhooks.

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

Este artigo abrange os seguintes tópicos:

• Edição e gerenciamento de webhooks
• Visualização da atividade de um webhook
• Depuração de problemas de webhooks

Edição e gerenciamento de webhooks

Na maioria dos casos, os administradores podem editar, clonar, desativar e apagar webhooks. No entanto, os webhooks que são criados por requisitos do aplicativo podem ser editados, mas não podem ser clonados nem apagados. Os webhooks criados pelos requisitos do aplicativo podem ser atualizados pelo desenvolvedor e substituir as alterações feitas pelos administradores da conta. Após a criação do webhook, você não consegue alterar seu método de conexão.

Como editar um webhook

1. Na Central de administração, clique em Aplicativos e integrações na barra lateral e selecione Webhooks > Webhooks.
2. Encontre o webhook na lista, clique no ícone de menu de opções () na linha do webhook e clique em Editar.
3. Modifique o webhook conforme necessário.

   Todos os campos são editáveis. No entanto, quando se usa autenticação, a chave, o token ou a senha não podem ser visualizados após o webhook é criado ou atualizado. Para apagar um cabeçalho personalizado, clique no ícone ().

4. (Opcional) Teste as alterações que você fez no webhook.
5. Clique em Salvar.

Como clonar um webhook

1. Na Central de administração, clique em Aplicativos e integrações na barra lateral e selecione Webhooks > Webhooks.
2. Encontre o webhook na lista, clique no ícone de menu de opções () na linha do webhook e clique em Clonar.
3. Edite o Nome do webhook e modifique-o conforme a necessidade.
4. Clique em Atualizar.

Como desativar um webhook

1. Na Central de administração, clique em Aplicativos e integrações na barra lateral e selecione Webhooks > Webhooks.
2. Encontre o webhook na lista, clique no ícone de menu de opções () na linha do webhook e clique em Desativar.
3. Na tela de confirmação, clique em Desativar.

Como apagar um webhook

1. Na Central de administração, clique em Aplicativos e integrações na barra lateral e selecione Webhooks > Webhooks.
2. Encontre o webhook na lista, clique no ícone de menu de opções () na linha do webhook e clique em Apagar.
3. Clique em Apagar.

Visualização da atividade de um webhook

Cada webhook tem um registro de atividades. Além de um registro detalhado de invocações, você também pode ver o número de solicitações dos últimos sete dias.

A invocação do webhook é tentada novamente automaticamente três vezes após a falha se o ponto de extremidade retornar alguns códigos de resposta HTTP. Para obter mais informações e exemplos sobre cenários de novas tentativas, consulte a documentação do desenvolvedor sobre lógica de novas tentativas do webhook.

A Zendesk faz todo o possível para fornecer ações para webhooks apenas uma vez. No entanto, não é algo que possamos garantir. É possível que um webhook seja invocado pela mesma ação várias vezes ou, em certas circunstâncias, como quando o circuit breaker do webhook é acionado, as ações podem nem ser entregues. Para detectar invocações duplicadas, você pode usar assinaturas do webhook. Se isso prejudicar o seu fluxo de trabalho, certifique-se de que as ações decorrentes dos webhooks são idempotentes.

1. Na Central de administração, clique em Aplicativos e integrações na barra lateral e selecione Webhooks > Webhooks.
2. Encontre o webhook na lista, clique no ícone de menu de opções () na linha do webhook e clique em Ver detalhes.
3. Clique na aba Atividade.
4. Clique em Filtrar para filtrar o registro de atividades por data de início, data de término, hora de início, hora de término ou status e, em seguida, clique em Aplicar filtros.

Depuração de problemas de webhooks

Se um webhook não estiver funcionando corretamente, as invocações malsucedidas serão exibidas no registro de atividades do webhook. É possível filtrar o registro de atividades pelo status Falha ou por um tipo específico de erro. Na aba de atividades, você também pode clicar na ID de invocação para visualizar a solicitação e a resposta de uma invocação específica do webhook.

Na maioria dos casos, a resposta vem do serviço de terceiros que recebe a solicitação do webhook, não do próprio Zendesk. Normalmente, você precisa trabalhar com esse serviço para corrigir erros.

Você pode usar o código numérico no status da resposta para diagnosticar problemas. Esses códigos de status da resposta são padrão em solicitações HTTP. Para obter uma lista dos códigos de status de resposta HTTP padrão e seu significado, consulte HTTP response status codes no MDN web docs.

Observação: se um serviço usa códigos de status de resposta HTTP personalizados, pode ser necessário consultar a documentação.

As solicitações de webhook têm um tempo limite de dez segundos. Um status de resposta "Failed: 504 Gateway Timeout" mostra que um serviço não respondeu à solicitação de um webhook dentro desse prazo. O período de tempo limite não pode ser alterado.