Um Webhook permite que a mymento envie notificações automáticas para o seu sistema em tempo real por meio de requisições HTTP POST. Com ele, você recebe avisos instantâneos sobre eventos importantes — como novas vendas ou atualizações de status — eliminando a necessidade de consultar a API da mymento constantemente (polling).
Como Funciona
-
Destino: Você configura uma URL HTTPS segura do seu servidor.
-
Disparo: Sempre que o evento configurado ocorrer (ex: criação ou alteração de uma reserva), a mymento dispara uma requisição POST para a sua URL.
-
Payload: O corpo da requisição contém um objeto JSON detalhado com o tipo da ação (
createouupdate) e os dados completos da venda. -
Segurança (Opcional): Você pode definir um token de validação. Ele será enviado no cabeçalho
X-Webhook-Tokenda requisição, permitindo que seu servidor verifique a autenticidade da origem. -
Timeout: O tempo máximo que o seu servidor tem para responder à requisição é de 15 segundos.
⚠️ Requisito Prévio: O uso de Webhooks requer que o módulo de API esteja devidamente contratado e ativo em sua conta mymento.
Passo a Passo para Configuração
-
Acesse o painel administrativo em Configurações > Conexões > Webhook > Configurar.
-
No campo correspondente, insira a URL HTTPS do seu sistema que receberá os dados.
-
Selecione quais tipos de evento (gatilhos) sua aplicação deseja escutar.
-
(Opcional) Defina uma chave secreta no campo Token de Validação para aumentar a segurança do seu endpoint.
Estrutura do JSON Enviado (Payload)
Abaixo, veja um exemplo prático do objeto JSON enviado pela mymento em uma ação de atualização (update):
.png)