Cadastrando uma URL
Para cadastrar uma URL para recebimento de webhooks, siga estas etapas no nosso Portal: vá para a seção Configurações, escolha a opção Integrações e, em seguida, selecione API. Nessa área, você poderá visualizar os webhooks existentes e adicionar novos. É importante ressaltar que a seção de webhooks só estará visível se o token tiver sido gerado previamente. Abaixo, estão apresentadas as imagens ilustrativas do passo a passo mencionado anteriormente.
Token de autenticação (opcional)
Durante o cadastro da URL, é possível incluir um token para autenticar as requisições geradas pelo nosso sistema. O token fornecido será enviado no headerX-Webhook-Token em todas as requisições feitas para a URL cadastrada.
Retornando HTTP 200
Para que o nosso sistema considere a notificação como processada com sucesso, o status HTTP da resposta deve ser200 OK. Qualquer outro status será interpretado como uma falha.
O tempo limite para a resposta ao POST do webhook é de 5 segundos. Caso nenhuma resposta seja recebida dentro desse período, será considerado como falha.
Retentativas
Em caso de falhas, serão realizadas retentativas até que seja obtida uma resposta com o códigoHTTP 200 OK, ou até que seja atingido o limite máximo de 15 retentativas.
O intervalo entre as retentativas começa com 15 segundos, seguido por 30 segundos, 60 segundos, 120 segundos, 300 segundos e 600 segundos. A partir da sétima tentativa, os envios subsequentes serão realizados a cada 900 segundos.
Após as 15 retentativas, a notificação será descartada e o webhook correspondente será pausado. Enquanto pausado, todas as notificações subsequentes serão descartadas automaticamente.
Após certificar-se de que seu sistema responderá com HTTP 200 OK, você pode reativar o webhook através do nosso Portal.
Como testar
Caso deseje cadastrar um webhook na conta de testes no ambiente Sandbox, faça uma solicitação através do e-mailintegracao@cardapioweb.com.
Para testar o retorno dos webhooks, você pode utilizar ferramentas online como: