O webhook tem como finalidade notificar um endpoint* fornecido pelo cliente quando há uma alteração, criação ou exclusão de um chamado ou cliente dentro do TomTicket.
*O endpoint é uma página acessível publicamente via HTTP.

Para configurar sua conta para realizar o envio de webhooks, será necessário seguir os passos abaixo:

1. Pelo Painel Administrativo acesse o menu Gestão > Configurações da Conta > Webhook;
2. URL de Destino: informe para qual endereço o webhook irá disparar a notificação. Apenas endereços com suporte ao protocolo HTTPS e com certificado SSL válido poderão ser utilizados como URL de Destino, pois por segurança as informações são enviadas através de HTTPS;
3. Segredo da Aplicação: informe uma chave secreta para gerar o cabeçalho X-Hub-Signature, que irá garantir que a notificação foi realmente enviada pelo TomTicket. Importante: Essa chave nunca deverá ser divulgada, pois ela garante a autenticidade da mensagem;
4. Notificar para: marque nessa opção quais cadastros irão gerar notificação, no momento apenas são suportadas notificações para chamados e clientes;
5. Clique em Salvar Modificações para receber a chave de confirmação.

Validação da Configuração

Antes de começar a enviar notificações, será necessário validar se a URL informada é válida. Para isso será enviada uma notificação em JSON no seguinte formato:

 {
  "id": "CODIGO_VALIDACAO",
  "type": "account",
  "action": "validation"
 } 

A propriedade id contém a chave que deve ser informada para confirmar a sua propriedade sobre o endereço do webhook, ela deve ser inserida no Código de Validação e após isso clique no botão Validar. Caso seja necessário enviar novamente o código, clique no botão Enviar Código Novamente.

Desativação Automática de um Webhook

Caso o status de retorno do webhook seja diferente de 200 ou caso ocorra timeout de conexão (tempo máximo de tentativa de conexão é de 20 segundos) durante um intervalo de 12 horas, seu webhook será desativado por motivos de segurança.