Passar para o conteúdo principal
Todas as coleçõesIntegrações e APIIntegrações de software
Configuração da integração via Webhook
Configuração da integração via Webhook

Envie eventos da plataforma para outros softwares por meio de um simples webhook

Atualizado há mais de uma semana

Considere dois sistemas, A e B, que precisam se comunicar. Um webhook é um método que permite ao Sistema B enviar automaticamente uma notificação ao Sistema A quando um evento específico ocorre. Assim, sempre que um evento relevante acontece no Sistema B, o webhook envia uma notificação com detalhes sobre o evento para o Sistema A, permitindo que ações sejam executadas imediatamente. Em resumo, um webhook age como um "sinal de alerta", garantindo comunicação eficiente e atualizada entre os sistemas.

Como configurar sua integração com webhook

A configuração de um webhook é feita em etapas, cada aba a seguir possui sua importância para o funcionamento da integração.

O primeiro passo é contratar a sua integração. Para isso, fale com o seu gerente de contas.

Após a contratação, a primeira ativação do seu webhook é feita pelo nosso time de suporte. Para isso, precisamos de algumas informações:

  • URL do webhook

  • Cliente que será cadastrado

  • Câmera que será cadastrada

  • Usuário que será cadastrado (não é obrigatório)

  • Evento que ativará o webhook

Feito isso, nosso time fará ativação do seu primeiro webhook.

Como consultar e modificar sua integração com webhook

Para consultar e modificar sua integração com webhook, o primeiro passo é acessar o menu lateral esquerdo e selecionar a opção Integrações de Sistemas.

Na tela seguinte, você verá a sua integração com webhook cadastrada. Para editá-la, basta clicar no nome da integração.

Etapa 1 - Sistemas

Escolha o sistema de destino como sendo Webhook e preencha as informações necessárias na integração.

  • Descrição: nome personalizado para identificar a integração na listagem da Monuv.

  • URL do webhook: campo para adicionar a URL do sistema de destino e que receberá os eventos (Obs: Neste campo insira a URL sem a porta de acesso)

  • Porta de acesso: informação da porta de acesso do sistema de destino (se não existir, deixar em branco).

  • Método HTTP: método para comunicação com o sistema de destino, como padrão, pode ser definido como POST

  • Token de autenticação: campo para adicionar o token da integração com o sistema de destino (se não existir, deixar em branco).

Etapa 2 - Clientes

Ao vincular os registros de clientes entre os sistemas, um cliente Monuv será vinculado ao cliente no sistema de destino.

Clique na aba Clientes e cadastre a sua integração dentro de um cliente

Para cada cliente que desejar que haja tráfego de informações da Monuv para outro sistema, você deverá repetir essa configuração. Para essa etapa você necessita ter as seguintes informações:

  • Sistema: é a integração via webhook que foi criada e que está aparecendo na aba Sistemas

  • Cliente: é o cliente que estará atrelado à essa integração e que deve estar cadastrado na Monuv

  • ID Externo: é o ID identificador da conta desse cliente que será enviado para o sistema com o qual será feita a integração, sendo personalizável de acordo com a sua necessidade

Preencha o sistema, cliente, ID externo e clique em salvar.

Etapa 3 - Câmeras

Para cada câmera que desejar que haja tráfego de informações da Monuv para o sistema de destino, você deverá repetir essa configuração.

Para isso, acesse a guia Câmeras, selecione o cliente que você vinculou à integração e cadastre uma integração na câmera. Não esqueça de selecionar o cliente que acabou de ser criado.

Para a próxima configuração, vão ser necessários os seguintes dados:

  • Câmera: escolher qual câmera da plataforma da Monuv será utilizada, a identificação estará com o mesmo nome já apresentado na plataforma.

  • ID externo: é o ID identificador da câmera que será enviado para o sistema com o qual será feita a integração, sendo personalizável de acordo com a sua necessidade

Etapa 4 - Usuários

Para cada usuário que desejar que haja tráfego de informações da Monuv para o sistema de destino, você deverá repetir essa configuração.

OBS: Lembre-se, essa aba não é obrigatória no cadastro da integração.

Etapa 5 - Eventos

Na etapa de eventos será criada a correspondência entre cada tipo de evento que é gerado pela Monuv e a identificação desse evento no sistema de destino, considerando o ID externo fornecido. Isso garante que o operador identifique e classifique corretamente as ocorrências na interface do sistema de destino.

  • Sistema: é a integração webhook que foi criada e que está aparecendo na aba Sistemas

  • Tipo de evento: tipos de eventos e gatilhos disponíveis na Monuv, que será o evento enviado na integração

    • Analíticos de IA

    • Alerta na câmera

    • Evento gerado via QR Code

    • Botão de pânico

    • Alteração de status de câmera

  • ID externo: é o ID identificador do evento que será enviado para o sistema com o qual será feita a integração, sendo personalizável de acordo com a sua necessidade

Após esse cadastro, os eventos gerados pelos analíticos vinculados à conta aparecerão dentro do sistema de destino, além, é claro, de ficarem registrados na Monuv. Conte com o suporte da Monuv para te orientar e apoiar neste processo. Uma vez validada a configuração da integração os dados irão trafegar de forma automática.

Como testar a integração com o webhook

Após o cadastro do seu webhook ter sido finalizado, é possível realizar um teste para enviar um evento e validar se os sistemas já estão se comunicando corretamente. Para isso, na mesma página de Integrações de Sistemas, acesse a opção Enviar evento.

Em seguida, basta preencher os dados do webhook que foi cadastrado nas etapas anteriores e selecionar Enviar. Após o carregamento, uma mensagem em verde ou vermelha será apresentada, informando se o evento foi enviado corretamente.

Com isso, já é possível validar completamente o funcionamento do seu webhook e, uma vez validada, a sua integração irá funcionar naturalmente.

Documentação completa

Acesse a documentação de webhooks da Monuv para entender todos os endpoints disponíveis e como utilizá-los. Documentação da API e Webhooks Monuv.

Respondeu à sua pergunta?