Gerenciar Webhooks

Gerenciar Webhooks

Visão geral dos webhooks

Webhooks facilitam as notificações HTTP automatizadas. As notificações são acionadas em aplicativos de terceiros de acordo com os requisitos de negócios quando uma ação predefinida é executada pelo usuário na organização.

Casos de uso de negócios de Webhooks

  1. Os webhooks podem ser usados para colaborar com fornecedores de SMS de terceiros para enviar alertas de SMS a usuários vinculados a um cartão , como criadores de cartões ou designados.
  2. Você também pode se conectar ao aplicativo de logística da sua organização para notificar a entrega de pedidos quando os cartões associados  forem concluídos. 

Webhooks também podem ser usados em transições de blueprint e regras de negócio.

Adicionar webhook

  1. Navegue até   e selecione Webhooks e Advanced (Avançado) no menu.
  2. Clique no botão  New Webhook  (Novo Webhook).
  3. Insira os detalhes. Consulte a tabela abaixo para saber a especificação de cada campo. 
  4. Clique em Salvar.



Lista de campos na configuração do Webhook

Nome do campo
Descrição
Tipo de dados
Limite
Nome

Especifique o nome do webhook.
Texto
3 a 50 caracteres
URL para notificar

Especifique o URL da API de um aplicativo de terceiros ou Zoho.

URL
265 caracteres
Método

Selecione o tipo de método de API: POST ou GET. Por padrão, o método POST é selecionado.

Botão de opção
-
Parâmetros em formato padrão (JSON, XML etc.)

1. Insira o nome do parâmetro e selecione um valor a ser inserido como descrição.
2. Esses parâmetros de solicitação são usados ao acionar a notificação do webhook para aplicativos de terceiros.
3. São permitidos no máximo 6 parâmetros. Cada nome de parâmetro pode ter até 25 caracteres.

Texto
Nome do parâmetro - 25 caracteres
Valor do parâmetro - 5000 caracteres
Parâmetros no formato padrão (Nome=valor)

1. Insira o nome do parâmetro e selecione o valor correspondente do parâmetro.
2. Esses parâmetros de solicitação são significativos ao acionar a notificação do webhook para aplicativos de terceiros.
3. São permitidos no máximo 6 parâmetros. Cada nome de parâmetro pode ter até 25 caracteres.

Texto
Nome do parâmetro - 25 caracteres
Anexar parâmetros personalizados

1. Especifique o nome do parâmetro e o seu valor correspondente para o webhook.
2. Máximo de 5 parâmetros são permitidos. Cada nome de parâmetro pode ter 25 caracteres.
3. Este par chave/valor é usado principalmente para enviar tokens de autenticação, chave de API, tokens de segurança etc.

Texto
Nome do parâmetro - 25 caracteres
Valor do parâmetro - 100 caracteres
Cabeçalhos personalizados 
1. Especifique o nome do cabeçalho e o valor correspondente para o webhook. 
2. É permitido um máximo de 3 cabeçalhos. Cada nome de cabeçalho pode ter até 25 caracteres. 
3. Pode ser usado para enviar cookie, agente do usuário, referenciador etc.  
Texto
Nome do cabeçalho - 25 caracteres 
Valor do cabeçalho - 200 caracteres
Visualizar URL
Visualize o URL completo do webhook a ser enviado ao aplicativo de terceiros. Este campo não pode ser editado. 
-
-

Restrições em Webhooks

  • Um máximo de 3 webhooks pode ser associado a uma regra de negócios . 
  • No máximo 3 webhooks podem ser associados a uma transição .
  • Seis parâmetros relacionados ao cartão e cinco parâmetros personalizados são permitidos por webhook.
  • Se uma execução do webhook falhar após três tentativas, ela será desativada.

Associar Webhooks com Regras de negócios

  1. Navegue até   e selecione  Business Rules (Regras de negócio) em  Automation (Automação) no menu.
  2. Crie uma nova regra de negócios ou abra uma regra existente.  Saiba mais sobre as regras de negócio.
  3. Preencha os detalhes da regra e passe para  Criteria & Actions (Critérios e ações).
  4. Agora ,  clique no  icone ao lado de   Instant Actions (Ações instantâneas) ou Schedule Actions (Ações agendadas) e selecione Webhooks na lista suspensa.
  5. Selecione um ou mais webhooks na lista de webhooks disponíveis ou clique em Add (Adicionar) Webhook.
  6. Depois que o webhook for selecionado, clique em Apply (Aplicar) .
  7. Clique em Save (Salvar). 



Associar Webhooks a Blueprints

  1. Navegue até    e selecione  Orchestration (Orquestração)  no menu.
  2. Selecione uma orquestração existente ou crie uma nova. Saiba mais sobre orquestração. 
    1. Você entrará na Etapa 1: Criar Formulário.
  3. Navegue até a Etapa 2: Design Blueprint (Projetar Blueprint). 
  4. Clique em uma transição e navegue até a seção  After (Após) no painel direito. 
  5. Agora, em Instant Actions (Ações instantâneas) ou Schedule Actions (Ações agendadas), clique no ícone Ao lado de Configure Webhooks (Configurar Webhooks) .
  6. Selecione um ou mais webhooks na lista de webhooks disponíveis ou clique em Add (Adicionar) Webhook.
  7. Clique em Aplicar.
  8. Salve o Blueprint.  



Editar/excluir Webhook

Para editar um webhook, selecione Webhooks em Advanced (Avançado) no menu , clique no webhook que deseja editar. Modifique o webhook e clique em Save (Salvar).
Para excluir um webhook, passe o mouse sobre o nome do webhook e clique em  . Selecione  Delete (Excluir) na janela pop-up e confirme sua ação.   


Uma vez excluído, o webhook não será mais associado a nenhum blueprint.


    • Related Articles

    • Gerenciar regras de negócios

      O que é uma regra de negócio? Uma regra de negócio ajuda você a acionar um evento ou uma cadeia de eventos automatizados, quando uma ação definida ocorre em um cartão. Por exemplo, quando o  campo de responsável de um cartão é atualizado, talvez você ...

    • Gerenciar campos

      Os campos são elementos individuais em um formulário que classifica os dados do usuário. O Qntrl oferece uma variedade de tipos de campo que representam diferentes tipos de dados de usuário em formulários. Nós respeitamos todos os campos criados em ...

    • Gerenciar scripts de servidor

      Os scripts de servidor ajudam você a codificar a lógica de negócios específica da empresa para gerenciar o banco de dados, executar processos demorados rapidamente e automatizar atividades em seus fluxos de trabalho de negócios. Esses scripts em ...

    • Gerenciar tabelas

      As tabelas ajudam a armazenar dados de referência em um formato tabular dentro do Qntrl . Você pode armazenar dados vitais para dar suporte aos seus processos de negócios aqui. Além disso, os dados nas tabelas podem ser listados em cartões usando ...

    • Gerenciar widgets.

      Os widgets permitem que você crie aplicativos personalizados para seus negócios diretamente do Qntrl. O Qntrl fornece um editor nativo com estrutura predefinida e arquivo de manifesto de plug-in pré-configurado para criar Widgets. Você pode ...