Skip to main content

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.

Projeto Exemplo

Existe um projeto de exemplo no Github demonstrando a a integração tanto do webhook quanto do envio de comandos que pode ser acessado aqui.

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,
  "irisDeviceId": "",
  "hermesDeviceId": "",
  "sensors": [
    {
      "id": 0,
      "scalarValue": 0
      "bytesValue": []
      "textValue": ""
    }
  ],
  "createdAt": "0001-01-01T00:00:00Z"
}

Descrição dos Campos​

evento:

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

sensor:

  • id: Identificador do sensor
  • scalarValue: Valor numérico do sensor (se aplicável)
  • bytesValue: Valor em bytes do sensor (se aplicável)
  • textValue: Valor em texto do sensor (se aplicável)
hermesDeviceId

Quando utilizando um Hermes diretamente conectado ao WiFi/Internet, os campos "irisDeviceId" e "hermesDeviceId" serão o mesmo.

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