Isenção de responsabilidade: Este artigo foi gerado usando tradução automática.

Canal de notificação Webhook

Prev Next

Planos que suportam este recurso: Professional Business Enterprise

Um Webhook é um método de enviar automaticamente dados em tempo real de um aplicativo para outro quando eventos específicos ocorrem. Webhooks no Document360 permitem enviar notificações para outros aplicativos, mantendo sua equipe atualizada sobre mudanças no portal da base de conhecimento, site ou widget.

Por exemplo, sua equipe de suporte usa uma ferramenta de comunicação como o Slack. Ao configurar um Webhook, você pode notificar instantaneamente a equipe quando um artigo for atualizado, garantindo que todos tenham as informações mais recentes sem precisar verificar manualmente as atualizações.


Configurando um canal de notificação no Webhook

Para configurar um canal de notificação Webhook no Document360, siga os passos abaixo:

  1. Navegue até Configurações () > Portal da base de conhecimento na barra de navegação da esquerda do portal da base de conhecimento.

  2. No painel de navegação esquerdo, navegue até Notificações.

    Por padrão, a aba Canais de Notificação será selecionada.

  3. Clique em Novo canal.

  4. No painel de Canais Disponíveis , selecione Webhook e clique em Próximo.

    Overview of notification channels including Slack, Microsoft Teams, and WebHook options.

    O painel de configuração do canal vai aparecer.

  5. No campo de nome Friendly , insira um nome único para o seu canal Webhook.

  6. No menu suspenso do método Request , selecione POST ou PUT, dependendo de como você quer enviar os dados.

  7. No campo URL do Webhook , insira a URL do aplicativo para onde deseja enviar notificações.

  8. Escolha o formato de mensagem desejado no menu suspenso Solicitar conteúdo .

  9. Se forem necessários cabeçalhos adicionais, clique em Adicionar novos () em Cabeçalhos Padrão e adicione-os.

  10. Opcionalmente, insira a chave de Autorização se o aplicativo receptor exigir autenticação.

  11. Clique em Salvar.

    Configuration settings for a WebHook channel including URL and authorization key.

NOTA

Para mais informações, veja o cabeçalho Request.

Depois de salvar, um novo canal de notificação Webhook com o nome especificado é criado. Agora, navegue até a aba de mapeamento de notificações para mapear configurações com seu aplicativo Webhook de acordo com suas necessidades.


Perguntas Freqüentes

Quais informações estão incluídas em uma notificação do Webhook?

Quando um Webhook é acionado, o Document360 envia um payload JSON estruturado para a URL configurada. A carga útil contém detalhes do evento, o usuário que realizou a ação e metadados sobre o artigo ou projeto.

Você pode me mostrar um exemplo de carga útil?

Sim. Abaixo está um exemplo de carga útil para o evento "Artigo publicado" :

{
  "Knowledge base name": "Document360 2.0",
  "Event": "Article published",
  "User": "Matt sterling",
  "User email": "matt.sterling@document360.co",
  "Logged on (UTC)": "09/12/2025 06:01:04",
  "Article name": "Webhook notification test",
  "Article id": "e1444f0x-0xx0-000x-xxx0-0x3f2bc3713c",
  "Article URL": "https://Document3602.0/document360.io/docs/en/webhook-notification-test",
  "Language": "English",
  "Project version id": "55144000-0xxx-000x-0000-0x2346b3bms3",
  "Language code": "en"
}

Os campos na carga útil são:

  • Nome da base de conhecimento: O nome do projeto da base de conhecimento.

  • Evento: O tipo de ação que desencadeou o Webhook (por exemplo, artigo publicado).

  • Usuário / E-mail de usuário: O membro da equipe que realizou a ação.

  • Logado (UTC): Data e hora da ação, em UTC.

  • Nome do artigo / ID do artigo / URL do artigo: Detalhes e link para o artigo afetado.

  • Idioma / Código de idioma: O idioma do artigo.

  • ID da versão do projeto: Identificador para a versão da Base de Conhecimento.

As cargas úteis diferem para outros eventos (por exemplo, artigo atualizado, excluído)?

Sim, a estrutura de carga útil permanece semelhante, mas o campo Evento muda dependendo da ação — por exemplo, Artigo atualizado ou Artigo deletado. Não apenas o campo do evento, mas outros campos, como detalhes do usuário, detalhes do artigo e versão do projeto, também podem variar. Por exemplo:

{
  "Knowledge base name": "Document360 2.0",
  "Event": "Extension token deleted",
  "User": "Matt sterling",
  "User email": "matt.sterling@document360.co",
  "Logged on (UTC)": "09/12/2025 06:47:10",
  "Extension": "MAKE"
}
{
  "Knowledge base name": "Document360 2.0",
  "Event": "Widget setting created",
  "User": "Matt sterling",
  "User email": "matt.sterling@document360.co",
  "Logged on (UTC)": "09/12/2025 06:47:36",
  "Widget setting name": "Knowledge base widget"
}
{
  "Knowledge base name": "Document360 2.0",
  "Event": "Drive folder added",
  "User": "Matt sterling",
  "User email": "matt.sterling@document360.co",
  "Logged on (UTC)": "09/12/2025 06:48:08",
  "Folder name": "Media"
}