feat(connector): type health.incidents - #179
Merged
Merged
Conversation
Gabrielpanga
changed the title
Types the `incidents` array now returned on a connector's `health` object: the incidents affecting that connector right now, each with a customer-facing title, severity, state and a permalink to status.pluggy.ai. Absent when the connector has none, so its presence is the signal — hence optional. It describes the institution, not the caller's own connections, which is what ConnectorHealthDetails already covers; the doc comment says so, because the two live next to each other and answer different questions.
Gabrielpanga
force-pushed
the
feat/connector-health-incidents
branch
from
September 3, 2026 07:17
9182dda to
7200b25
Compare
Two more fields on the incident object. `type` is what is broken, as opposed to how badly (severity) or how far along Pluggy is (state) — nineteen values, so a caller can group the same problem across institutions and decide which incidents are worth putting in front of a user. A scheduled maintenance and a missing-transactions bug both read as "degraded" otherwise. `product` names the affected product line. Both are required: OTHER covers the unclassified case, so absent is not a state a caller has to handle.
This was referenced Sep 5, 2026
Opabby
approved these changes
Sep 8, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Types the
incidentsarray now returned on a connector'shealthobject.Connector.health.incidents— the incidents affecting that connector right now, as published on status.pluggy.ai, each with a customer-facingtitle,severity,stateand aurlpermalink. Optional, because it is absent when the connector has no active incident, so its presence is the signal itself.Adds
ConnectorIncidentplus the three enums (ConnectorIncidentKind,ConnectorIncidentSeverity,ConnectorIncidentState) asas constarrays with derived union types, matching how the rest of this file is written.The doc comments carry the two things a caller cannot infer from the shape:
ConnectorHealthDetails, which sits right next to it and answers a different question.Types only, no runtime change.
pnpm buildandeslintclean.tsc --noEmitreports zero errors undersrc/; the pre-existing failures intests/payments/*(nockRequestBodyMatcher) are untouched by this.