Criar uma nova configuração de alerta

post

https://api.cobli.co/v1/triggers/

Cria uma nova configuração de alerta para monitoramento e notificações.
A configuração define quando e para quais veículos os alertas (eventos) serão disparados.

Há dois modelos mutuamente exclusivos — envie os campos de apenas um:

Legado: condition_id + days_of_week + start_time + end_time.
Novo: event_id + condition_params + trigger_time_windows.

Não misture os dois modelos. Os alertas novos são FATIGUE, DANGEROUS_DRIVING,
DISTRACTED_DRIVING, VEHICLE_MOVEMENT, DRIVER_IDENTIFICATION_V2, IGNITION e
VEHICLE_STOP; os demais são legados. Veja condition_params para as condições permitidas
por evento.

Resumo de alertas (bulletin)

O corpo aceita opcionalmente um bloco bulletin para criar um resumo de alertas
associado ao alerta na mesma transação. Se informado, o alerta e o bulletin são
persistidos juntos e o campo bulletin da resposta é preenchido com o registro criado.
Para atualizar ou desativar o resumo depois, use PUT /v1/triggers/{triggerId}
reenviando (ou omitindo) o bloco bulletin.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Baseado em condition_id, com a janela de monitoramento definida por days_of_week, start_time e end_time. Não aceita event_id.

name

string

required

length between 1 and 255

Nome do alerta

condition_id

uuid

required

Apenas alertas legados. ID da condição/regra associada ao alerta. Mutuamente exclusivo com event_id — não envie os dois. Em alertas legados é obrigatório.

event_id

uuid

Apenas alertas novos. ID do evento (tipo de alerta) associado. Mutuamente exclusivo com condition_id — não envie os dois. Quando informado, o alerta é tratado como novo (is_legacy = false) e deve usar condition_params e trigger_time_windows no lugar de days_of_week, start_time e end_time. Identifica um dos eventos novos: FATIGUE, DANGEROUS_DRIVING, DISTRACTED_DRIVING, VEHICLE_MOVEMENT, DRIVER_IDENTIFICATION_V2, IGNITION, VEHICLE_STOP.

condition_params

object

Parâmetros das condições do evento — exclusivo dos alertas novos (enviados junto de
event_id). Não deve ser informado em alertas legados (que usam condition_id).

Formato: objeto (mapa) em que a chave é o id da condição (UUID definido no schema do
evento) e o valor é o parâmetro escolhido pelo usuário.

Regras de validação:

Somente condições de origem USER podem ser informadas. Condições INTERNAL (gerenciadas
pela engine) não devem aparecer em condition_params.
Condições obrigatórias devem estar presentes; condições opcionais omitidas usam o valor
padrão do evento.
Não é permitido informar id que não exista no schema do evento.
O valor deve respeitar o tipo e os limites da condição:
- ENUM: string ou lista de strings, restrita aos valores permitidos.
- BOOLEAN: true ou false.
- NUMERIC / TIME: número dentro de [mínimo, máximo] (condições TIME são em segundos).

Os ids de condição abaixo são estáveis (fazem parte do schema do evento). Para descobrir o
event_id correspondente, consulte a listagem de eventos disponíveis.

Fadiga — `FATIGUE`

id da condição	condição	tipo	obrigatória	valores permitidos
`d88f2e00-bb77-4c01-9001-000000000001`	Causa (`CAUSED_BY`)	ENUM	Sim	`YAWN`, `EYESCLOSED`
`d88f2e00-bb77-4c01-9001-000000000002`	Velocidade (`SPEED_IN_KMH`)	NUMERIC (km/h)	Não	0 a 300

Direção perigosa — `DANGEROUS_DRIVING`

id da condição	condição	tipo	obrigatória	valores permitidos
`3ccb276d-11f1-48b8-a527-7b4ea4a50e7a`	Tipo de risco (`RISK_EVENT_TYPE`)	ENUM	Não	`FAST_ACCELERATION_35`, `FAST_ACCELERATION_45`, `FAST_ACCELERATION_55`, `SPEEDY_TURN_LEFT`, `SPEEDY_TURN_RIGHT`, `HARD_BREAK_35`, `HARD_BREAK_45`, `HARD_BREAK_55`
`b1b1b176-ad5b-4aa5-8e60-5c5832ce253a`	Causa (`CAUSED_BY`)	ENUM	Não	`TAILGATING`
`e4f5a6b7-c8d9-4e0f-a1b2-c3d4e5f60001`	Velocidade (`SPEED_IN_KMH`)	NUMERIC (km/h)	Não	0 a 300

Direção distraída — `DISTRACTED_DRIVING`

id da condição	condição	tipo	obrigatória	valores permitidos
`b7e12f3c-4d8a-4f91-a2c5-1e9f6d0b3e47`	Causa (`CAUSED_BY`)	ENUM	Sim	`DISTRACTEDDRIVING`, `SMOKING`, `PHONEUSAGE`
`d4cba3d4-01eb-4f36-877d-e912e84daf46`	Velocidade (`SPEED_IN_KMH`)	NUMERIC (km/h)	Não	0 a 200

Movimento do veículo — `VEHICLE_MOVEMENT`

id da condição	condição	tipo	obrigatória	valores permitidos
`a1a1a1a1-0001-0001-0001-000000000002`	Duração mínima em movimento	TIME (segundos)	Sim	3 a 86400

Motorista não identificado — `DRIVER_IDENTIFICATION_V2`

id da condição	condição	tipo	obrigatória	valores permitidos
`bf15b81c-062e-4a8f-8824-42dbdc39bb7a`	Duração mínima sem motorista	TIME (segundos)	Sim	180 a 86400

Ignição — `IGNITION`

id da condição	condição	tipo	obrigatória	valores permitidos
`27a1f90b-1ad7-4c93-bc62-f6477fe12055`	Ignição ligada (`IS_IGNITION_ON`)	BOOLEAN	Sim	`true` / `false`
`6eb27607-5f43-4f50-93c3-97d9d23a4fbf`	Duração mínima	TIME (segundos)	Sim	a partir de 180

Parada do veículo — `VEHICLE_STOP`

id da condição	condição	tipo	obrigatória	valores permitidos
`e8f2b4c5-6a3d-4f9e-0b7c-4d2e8f5a9b3c`	Duração mínima da parada	TIME (segundos)	Sim	a partir de 180

vehicle_group_ids

array of uuids

Lista de IDs dos grupos de veículos

vehicle_group_ids

vehicle_ids

array of uuids

Lista de IDs dos veículos

vehicle_ids

geofence_ids

array of uuids

Lista de IDs dos locais de interesse

geofence_ids

device_ids

array of strings

Lista de IDs dos dispositivos

device_ids

days_of_week

array of integers

required

length between 1 and 7

Apenas alertas legados. Dias da semana ativos (1=Segunda-feira, 2=Terça-feira, 3=Quarta-feira, 4=Quinta-feira, 5=Sexta-feira, 6=Sábado, 7=Domingo). Nos alertas novos use trigger_time_windows.

days_of_week*

start_time

string

required

^([01]?[0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]$

Apenas alertas legados. Horário de início no formato HH:mm:ss. Nos alertas novos use trigger_time_windows.

end_time

string

required

^([01]?[0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]$

Apenas alertas legados. Horário de fim no formato HH:mm:ss. Nos alertas novos use trigger_time_windows.

trigger_time_windows

array of objects

Apenas alertas novos. Janelas de monitoramento (dia da semana + intervalo de horário). Substitui days_of_week, start_time e end_time dos alertas legados — não envie os dois modelos juntos.

trigger_time_windows

allow_notifications

boolean

Defaults to true

Se as notificações devem ser habilitadas para este alerta

timezone

string

Defaults to America/Sao_Paulo

Fuso horário a ser utilizado

notified_users

array of uuids

IDs de usuários a serem notificados

notified_users

min_road_speed_severity

string

enum

Obrigatório para alertas de categoria ROAD_SPEED_LIMIT_X_MINUTES. Valores válidos são medium, high, higher

Allowed:

driver_identification_without_driver_recurrence

string

enum

Obrigatório para alertas de identificação sem motorista

Allowed:

notified_users_channels

array of objects

Configuração de canais de notificação por usuário

notified_users_channels

request_video

boolean

Defaults to false

Para alertas que suportam vídeo, como ROAD_SPEED_LIMIT (Excesso de velocidade da via) e VEHICLE_SPEED_LIMIT (Excesso de velocidade do veículo).

geofence_speed_limit_in_km_h

float

≥ 0

Limite de velocidade customizado para alertas de geofence (em km/h)

priority

string | null

Prioridade do alerta (texto livre, ex. "high", "medium", "low")

description

string | null

Descrição livre do alerta

bulletin

Configuração de resumo de alertas (bulletin) associada a um alerta. Um bulletin agenda o
envio periódico de um relatório com os alertas gerados pela configuração de alerta pai para
uma lista de destinatários por e-mail.

Regras de agendamento conforme a frequência:

DAILY: send_day_of_week e send_day_of_month devem ser null.
WEEKLY: send_day_of_week (1-7) é obrigatório; send_day_of_month deve ser null.
MONTHLY: send_day_of_month (1-31) é obrigatório; send_day_of_week deve ser null.
Dias inexistentes no mês (ex.: 31 em fevereiro) são ajustados para o último dia do mês.

Os e-mails em recipients são normalizados para minúsculas e não podem se repetir dentro de
um mesmo bulletin (comparação case-insensitive).

Fadiga — FATIGUE

Direção perigosa — DANGEROUS_DRIVING

Direção distraída — DISTRACTED_DRIVING

Movimento do veículo — VEHICLE_MOVEMENT

Motorista não identificado — DRIVER_IDENTIFICATION_V2

Ignição — IGNITION

Parada do veículo — VEHICLE_STOP

201Configuração de alerta criada com sucesso

400Dados de entrada inválidos

401Acesso negado - Header de API Key inválido ou ausente

500Erro interno do servidor

Fadiga — `FATIGUE`

Direção perigosa — `DANGEROUS_DRIVING`

Direção distraída — `DISTRACTED_DRIVING`

Movimento do veículo — `VEHICLE_MOVEMENT`

Motorista não identificado — `DRIVER_IDENTIFICATION_V2`

Ignição — `IGNITION`

Parada do veículo — `VEHICLE_STOP`