GET /alerts

Alertas de Status

Retorna notícias e incidentes operacionais da plataforma Polp. Use este endpoint para exibir comunicados no dashboard ou aplicativo.

public

Endpoint público — não exige headers x-api-client nem x-api-secret.

Disponível em /api/v1/alerts (prefixo v1 da plataforma), independentemente da base URL /api/v2 usada pelos demais endpoints Celcoin.

Base URL

https://api.polp.com.br/api/v1/alerts

Comportamento

  • Retorna alertas ativos, ordenados do mais recente ao mais antigo.
  • Quando não há alertas, a resposta é { "data": [] }.
  • Gerenciados em /admin/alerts.
  • type: news ou incident.
  • provider: pluggy, celcoin ou both.

Query Params

FieldTypeDescription
providerstringFiltra por provedor. Aceita pluggy, celcoin ou both. Quando pluggy/celcoin, também retorna alertas both.
typestringFiltra por tipo: news ou incident.

Response Fields

FieldTypeDescription
idintegerIdentificador do alerta.
contentstringMensagem do alerta. Suporta Markdown leve (negrito, itálico, código e links).
typestringTipo do comunicado: news (notícia) ou incident (incidente).
providerstringEscopo do alerta: pluggy, celcoin ou both.
created_atstringData de criação em ISO 8601.
updated_atstringData da última atualização em ISO 8601.

Tipos de alerta

typeUso
incidentIncidente em andamento — indisponibilidade, degradação ou impacto operacional.
newsNotícia / aviso — manutenção programada, mudança de comportamento ou comunicado geral.