Webhooks permitem que você assine eventos que ocorrem em um Fluid e receba automaticamente uma entrega de dados no seu servidor sempre que esses eventos ocorrerem.
Quando um evento ao qual seu webhook está inscrito ocorre, o Fluid enviará uma solicitação HTTP com dados sobre o evento para a URL que você especificou. Se o seu servidor estiver configurado para escutar entregas de webhook nessa URL, ele poderá tomar uma ação quando receber uma.
Em um quadro do Fluid, os eventos são baseados nas Ações/Cards que fazem parte do quadro. Os eventos suportados são Criar, Atualizar e Excluir. Sempre que um desses eventos ocorrer em uma Ação do quadro, seu webhook será chamado.
Acessar a opção de Integrações no quadro
Para começar, navegue até as opções de integrações no seu quadro a partir da aba Ferramentas.
Depois que a opção de Integração for selecionada e o diálogo abrir, você poderá selecionar a integração para Webhooks de Ação.
O diálogo a seguir apresentará a página de Configuração onde os detalhes de integração do quadro podem ser preenchidos.
Você pode aprender mais sobre como criar inicialmente um quadro no Fluid clicando aqui.
Preenchendo os Detalhes da Integração
Cada uma das seções para os detalhes da integração são as seguintes:
Nome | Nome amigável para esta integração que será usado como parte do cabeçalho da solicitação HTTP User-Agent. Terá o prefixo Fluid-Hookshot/{Nome} |
Ativo | Se a integração está atualmente habilitada para este quadro. |
URL do Webhook | O endpoint de URL para o qual você deseja que o Fluid envie solicitações. A URL completa é necessária, incluindo o http:// ou https:// ex: https://your.organisation.com/events |
Provedor de Autenticação | Veja abaixo na próxima seção. |
Provedor de Autenticação
O Fluid suporta Segredo Compartilhado, tokens PAT ou Autenticação Básica para acesso ao endpoint de URL do seu webhook. Os gerentes de projeto devem trabalhar com suas equipes de TI internas para fornecer as informações abaixo como parte dos requisitos de configuração.
NOTA: Todas as senhas/segredos são armazenados com segurança e criptografados em nosso cofre de chaves na nuvem. Todo acesso ao cofre de chaves é autenticado.
Segredo Compartilhado
Um segredo compartilhado é uma assinatura adicionada ao payload do webhook que é verificada pela sua organização na entrega. O valor do segredo é usado para assinar o payload usando SHA-256
Você deve definir um segredo de webhook para o seu webhook e verificar se a assinatura de cada entrega de webhook corresponde ao segredo. Isso ajuda a garantir que a entrega do webhook seja do Fluid. Para mais informações, consulte Validando Webhooks
O segredo do webhook deve ser uma string aleatória de texto com alta entropia. Você deve armazenar com segurança o segredo do seu webhook de forma que seu servidor possa acessá-lo.
Tokens PAT
Os tokens PAT são gerados pelos seus sistemas; são tokens bearer que serão passados para o endpoint de URL no cabeçalho de Autorização. Seus sistemas verificarão então o token bearer e permitirão o acesso se autenticado/autorizado.
Autenticação Básica
São os detalhes de nome de usuário e senha que serão passados no cabeçalho de Autorização. Seus sistemas verificarão então o nome de usuário e a senha e permitirão o acesso se autenticado/autorizado.
Parâmetros de Requisição
Defina uma lista delimitada por vírgulas de campos que você deseja incluir como parte do payload do webhook. Ex: se você deseja receber apenas as propriedades Título e Descrição da Ação, use "Title,Description"
Se não definido, uma lista padrão predeterminada de campos será usada.
Defina valores aqui apenas se quiser simplificar o payload de dados enviado como parte da requisição do webhook. Reduzir o tamanho do payload aumentará o desempenho ao analisar os resultados.
Nota: Os parâmetros de requisição se aplicam apenas à própria Entidade de Ação.
Parâmetros de Expansão
Defina uma lista delimitada por vírgulas de dados opcionais que você deseja incluir como parte do payload do webhook. Ex: se você deseja receber os Chats da Ação, use "Chats" ou "Chat,Related" para Chat e Relacionados.
Se não definido, nenhuma opção expandida será retornada. Você receberá o conjunto padrão de dados para uma Ação.
As opções de expansão suportadas incluem:
All
Expandirá todas as opções disponíveis para a ação e retornará o conjunto completo de dados.
Method
Incluirá dados de Método para a Ação. Métodos são links de URL para chamadas específicas que podem ser feitas nesta ação. São URLs auxiliares.
Related
Quaisquer outras ações relacionadas a esta Ação
Chats
Informações de Comentários/Chat disponíveis para esta Ação.
Gatilhos
Defina o tipo de eventos para os quais você deseja receber mensagens de webhook. Você pode alternar Sim/Não para controlar quais eventos serão enviados.
