Configuração

Para ativar e configurar Webhooks em nossa plataforma, siga os passos abaixo para garantir que tudo esteja configurado corretamente e com segurança, incluindo a validação das notificações via Token de Autenticação:

1. Login no Sistema: Primeiramente, faça login no sistema com suas credenciais de usuário.

2. Navegue até a Loja de Apps: Uma vez logado, acesse o menu principal e selecione a opção 'Loja de Apps'. Essa área contém todos os aplicativos e integrações disponíveis para uso com nossa plataforma.

3. Procurar por Webhook: Dentro da Loja de Apps, utilize a barra de busca ou navegue pelas categorias disponíveis para encontrar a aplicação 'Webhook'.

4. Ativação do Webhook: Ao localizar o aplicativo de Webhook, clique em 'Ativar' ou 'Instalar' para adicionar a funcionalidade ao seu ambiente. Será necessário configurar a URL de destino onde os Webhooks serão enviados.

5. Configuração de Eventos: Após a ativação, você será direcionado para uma página onde pode configurar os eventos específicos para os quais deseja receber notificações via Webhook. Selecione os eventos relevantes conforme sua necessidade.

6. Token de Autenticação (Segurança): Campo opcional. Ao preenchê-lo, todas as requisições daquele Webhook passam a incluir o token no cabeçalho (header) token, permitindo que o seu sistema valide se a notificação foi realmente enviada pela nossa aplicação. Deixando o campo em branco, o Webhook funciona normalmente, porém nenhum cabeçalho de autenticação é enviado. Recomendamos preenchê-lo. Veja o formato exato em Autenticação das notificações.

7. Salvar Configurações: Certifique-se de salvar as configurações após ter selecionado os eventos, informado a URL de destino e, se for utilizá-lo, o token de autenticação.

Ao seguir esses passos, você estará apto a receber notificações automáticas via Webhook, garantindo a autenticidade e a segurança das requisições enviadas pela plataforma.

Autenticação das notificações

Quando o Webhook tem um Token de Autenticação cadastrado, toda notificação enviada por ele inclui o cabeçalho token.

Item	Valor
Nome do cabeçalho	token
Formato do valor	A string exata cadastrada, sem prefixo e sem codificação

O nome do cabeçalho é tratado sem diferenciação entre maiúsculas e minúsculas, conforme o padrão HTTP — dependendo da linguagem utilizada, ele pode ser lido como token, Token ou TOKEN.

Exemplo de uma requisição enviada por um Webhook cujo token cadastrado é abc123:

POST /seu-endpoint HTTP/1.1
Content-Type: application/json
token: abc123

{
  "id_event": 83912,
  "event": "customer_created",
  "dateCreated": "2024-12-18 13:55:00",
  "data": []
}

Atenção

Não utilizamos o formato Authorization: Bearer <token>. O cabeçalho Authorization descrito em Autenticação pertence à API REST e não tem relação com os Webhooks: são mecanismos independentes, com tokens distintos.

Se o campo Token de Autenticação estiver em branco, nenhum cabeçalho de autenticação é enviado e a notificação chega apenas com os cabeçalhos padrão da requisição.