Webhook

O webhook é o mecanismo de notificação em tempo real que permite a integração do sistema com sua aplicação. Ao cadastrar uma URL de endpoint e um token de autenticação (entre em contato com nossa equipe), você receberá automaticamente os dados dos dispositivos através de requisições HTTP POST sempre que ocorrer uma transmissão.

Configuração

Para configurar o webhook:

1. Forneça uma URL pública acessível via HTTPS
2. Configure seu endpoint para receber requisições POST
3. Implemente a validação do token nas requisições recebidas

Estrutura de Dados

Cada evento enviado para seu webhook contém os seguintes campos:

{
  "id": 0,
  "version": 0,
  "companyId": "",
  "irisDeviceId": "",
  "hermesDeviceId": 0,
  "sensors": [
    {
      "eventId": 0,
      "id": 0,
      "value": 0
    }
  ],
  "logs": "",
  "createdAt": "0001-01-01T00:00:00Z"
}

Descrição dos Campos

• id: Identificador único do evento
• version: Versão do formato de dados
• companyId: Identificador da empresa
• irisDeviceId: Identificador do dispositivo Iris
• hermesDeviceId: Identificador do dispositivo Hermes
• sensors: Array contendo os dados dos sensores
• logs: Registros de log do dispositivo
• createdAt: Data e hora de criação do evento (formato ISO 8601)

Boas Práticas

• Retorne um status HTTP 200 para confirmar o recebimento
• Valide o token de autenticação em cada requisição
• Registre todas as requisições recebidas para auditoria