API de Notificações

Gerir as definições de notificações por email e Teams para o tenant autenticado.

Obter Definições de Notificações

GET /tenants/me/notifications

Exemplo de Pedido

curl https://api.aether365.io/tenants/me/notifications \
  -H "Authorization: Bearer <token>"

Exemplo de Resposta

{
  "success": true,
  "data": {
    "emailOnComplete": true,
    "emailOnFail": true,
    "teamsWebhookUrl": "https://outlook.office.com/webhook/...",
    "teamsOnComplete": true,
    "teamsOnFail": true
  }
}

Campos da Resposta

Campo	Tipo	Descrição
emailOnComplete	boolean	Enviar email quando uma análise é concluída com sucesso
emailOnFail	boolean	Enviar email quando uma análise falha
teamsWebhookUrl	string ou null	URL do webhook de entrada do Microsoft Teams
teamsOnComplete	boolean	Publicar no Teams quando uma análise é concluída
teamsOnFail	boolean	Publicar no Teams quando uma análise falha

---

Atualizar Definições de Notificações

Atualiza as definições de notificações. Apenas os campos incluídos são alterados.

PATCH /tenants/me/notifications

Corpo do Pedido

Todos os campos são opcionais. Inclua apenas os campos que pretende alterar.

{
  "emailOnComplete": true,
  "emailOnFail": true,
  "teamsWebhookUrl": "https://outlook.office.com/webhook/...",
  "teamsOnComplete": true,
  "teamsOnFail": false
}

Exemplo: Ativar notificações do Teams

curl -X PATCH https://api.aether365.io/tenants/me/notifications \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "teamsWebhookUrl": "https://outlook.office.com/webhook/your-webhook-url",
    "teamsOnComplete": true,
    "teamsOnFail": true
  }'

Exemplo: Desativar todas as notificações por email

curl -X PATCH https://api.aether365.io/tenants/me/notifications \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "emailOnComplete": false,
    "emailOnFail": false
  }'

Exemplo de Resposta

{
  "success": true,
  "data": {
    "emailOnComplete": false,
    "emailOnFail": false,
    "teamsWebhookUrl": "https://outlook.office.com/webhook/...",
    "teamsOnComplete": true,
    "teamsOnFail": true
  }
}

Erros

Código	HTTP	Descrição
AUTH_INSUFFICIENT_SCOPE	403	Permissões insuficientes para está ação
VALIDATION_ERROR	400	Formato de URL de webhook inválido