Integração: API de Eventos Personalizados - Whalemate Centro de ajuda

Referência técnica para integrar sistemas externos com a API de Eventos Personalizados da Whalemate. Permite registrar eventos de segurança reais associados a colaboradores, que impactam diretamente no seu Human Risk Score.

Para que serve?

Enviar eventos de segurança de sistemas externos (SIEM, EDR, ferramentas de detecção) para o Whalemate.
Registrar incidentes reais fora das simulações da plataforma.
Impactar o Human Risk Score de um funcionário de acordo com a severidade do evento.

Como se implementa?

Endpoint:

POST {{base_url}}/api/companies/v1/custom-events

Para obter o host de produção (base_url), entre em contato com seu representante da Whalemate ou escreva para nós através do chat de suporte.

Autenticação:

A API usa autenticação por API Key através do header X-API-KEY.

X-API-KEY: tu_api_key_de_empresa

Você pode gerar ou consultar sua API Key em Configuração → Geral → API Keys → Chaves Ativas.

Headers obrigatórios:

Header	Valor
`Content-Type`	`application/json`
`Accept`	`application/json`
`X-API-KEY`	Sua API Key de empresa

Corpo da solicitação (JSON):

Campo	Tipo	Obrigatório	Descrição
`title`	string	✅	Título do evento
`victim_email`	string	✅	Email do funcionário afetado (deve pertencer à sua organização)
`severity`	string	✅	`low` ou `high`
`description`	string	❌	Descrição opcional do evento

O campo severity aceita apenas