Configurar Webhooks

Visão geral

Ao criar integrações com o PlanRadar, o senhor pode usar webhooks para reagir a eventos que ocorrem dentro da sua conta do PlanRadar. Por exemplo, quando um usuário atualiza um tíquete, seu software é informado em tempo real para que possa executar as ações necessárias (por exemplo, recuperar novas informações do tíquete por meio da API aberta).

Tecnicamente, os webhooks podem ser considerados mensagens automatizadas que são enviadas pelo PlanRadar quando algo acontece. Essas mensagens contêm dados de carga útil e são enviadas para uma URL predefinida do seu serviço.

Como acessar Webhooks

1. Clique em Settings
2. Clique em Account
3. Clique em Webhooks
   

Adicionar um novo webhook

O PlanRadar permite que o senhor use facilmente webhooks para obter dados sempre que um determinado evento ocorrer. Para configurar seus webhooks:

1. Clique em Add new Webhook
   
2. Configure o Webhooks conforme explicado abaixo
3. Clique em Add
   
4. O webhook será listado na página do webhook
   

Depois de criar o webhook com êxito, toda vez que o evento especificado ocorrer, o webhook será acionado e enviará dados no formato JSON para o seu URL.

Configurar Webhooks

Ao adicionar um novo webhook, uma janela pop-up será aberta com diferentes guias para configurar o webhook. A guia de detalhes permite que o senhor configure os dados do webhook; as outras duas guias, autenticação e cabeçalhos, oferecem diferentes tipos de autenticação. Veja a seguir uma explicação sobre as diferentes guias e como configurar os campos em cada uma delas:

Detalhes

A guia de detalhes contém:

1. Descrição: fornece um nome descritivo curto. Certifique-se de que o nome escolhido descreva o webhook com precisão, para que seja fácil reconhecê-lo quando houver muitos webhooks configurados na sua conta.
2. Projects (Projetos): seleciona os projetos a serem monitorados para o evento de acionamento. O senhor pode selecionar um ou vários projetos no menu suspenso ou pode selecionar todos os projetos existentes em sua conta.
3. URL de destino: fornece um URL para o qual os dados do evento serão enviados. Esse URL pode ser criado a partir do aplicativo/site de destino. O URL de destino é obrigatório.
4. Events (Eventos): determina os eventos que devem acionar o webhook para enviar dados ao URL fornecido. É obrigatório selecionar pelo menos um evento.
   

Autenticação

Esse tipo de autenticação é usado com servidores que exigem um nome de usuário e uma senha. Para usar esse tipo de autenticação:

1. Digite o endereço de e-mail de sua conta do PlanRadar
2. Digite a senha
   

Cabeçalhos

Para servidores que exigem que a autenticação seja adicionada aos cabeçalhos das solicitações, use a guia "Headers" (Cabeçalhos) para adicionar pares de valores-chave.

Mostrar registros

O senhor pode visualizar um registro de todos os eventos que foram acionados, o que pode ser muito útil para depurar sua integração.

1. Clique no hiperlink View log ao lado do webhook
   
2. Será exibida uma lista de todos os eventos registrados
   
3. Clique em Show details para visualizar a solicitação e a resposta do evento
   

Editar Webhooks

Para editar um webhook:

1. Clique no ícone edit ao lado do webhook
   
2. Fazer as alterações
3. Clique em Save
   

Excluir Webhooks

Para excluir um webhook:

1. Clique no ícone delete ao lado do webhook
   
2. Clique em Delete para confirmar a exclusão do webhook
   

Quando um webhook é excluído, ele não pode ser restaurado.