Skip to content

CON-PFM-INT-002Connection

Markdown

CON-PFM-INT-002

Connection

Markdown
  • DocumentDraft
  • Product intentProposed
  • ImplementationObserved

Planning

Feature
FEAT-PFM-INT-02
Owned by
MOD-PFM-INT
Acted on by
CAP-PFM-INT-004, CAP-PFM-INT-005, CAP-PFM-INT-006, CAP-PFM-INT-007, CAP-PFM-INT-012, CAP-PFM-INT-013
Visible to
ACT-PFM-017, ACT-PFM-018, ACT-PFM-019, ACT-PFM-021, ACT-PFM-006
Not to be confused with
Customer adoption and accepted access, Account routing selection

Design

Specified by
DOM-PFM-INT-002

KindKey conceptProduct areaPlatformModuleIntegration access, customer extensions and shared workflow configurationRevision1

Read atservices-platform ad3f6a65react-console baf6dae3

The Formal Contract

The narrative above explains; the sections below are authoritative — the rules, scenarios and tests this document binds.

Definition
A connection is a workspace’s link to a provider account through an installed integration, carrying authentication facts, verified capabilities and observed health.
Synonyms
AccountConnected account

Relationships

ToStatementProvenance
CON-PFM-INT-001A connection belongs to a workspace installation and uses one of that integration’s releases.observed
CON-PFM-INT-003A call selects a connection through a binding or names it explicitly.test
services-platform:modules/integrations/tests/integration/services/bindings/resolve.integration.spec.js#reaches the processor that took the payment through its named connection
CON-PFM-INT-004Verification provisions the connection’s declared notification endpoints.test
services-platform:modules/integrations/tests/integration/services/connections/connection-jobs.integration.spec.js#creates one webhook endpoint row per kind the manifest declares, with no secret yet

Lifecycle

StateMeaningHow it changes
waiting for credentialThe account link exists without completed authentication.Credential entry, authorization or discard advances it.
verifyingAn account check is in progress.The check records success or failure.
activeThe connection is usable and passing checks.Probe results, credentials or staff lifecycle operations change its standing.
degradedThe usable connection has recent failures.Recovery checks, pause or removal can change it.
failed verificationAccount verification did not succeed.Staff correct authentication, retry or use the applicable removal path.
needs re-authorizationAuthentication must be renewed before use.An administrator replaces credentials or authorizes again.
suspendedA person has paused account use.Resume or final removal changes its standing.
disconnectedThe link has ended and its credentials are revoked.This state is final; a new link uses a new connection.

The Markdown files under specs/ in rhythmsoftware/rhythm-v2-docs are the canonical source of truth. This reader is a generated, read-only projection of them.