Rhythm 2.0 Specifications

Appearance

WF-PFM-INT-016Rotate a webhook signing secret

Markdown

WF-PFM-INT-016

Rotate a webhook signing secret

Markdown
  • DocumentDraft
  • ImplementationObserved

Planning

Implements
CAP-PFM-INT-013

KindWorkflowProduct areaPlatformModuleIntegration access, customer extensions and shared workflow configurationRevision1

Read atservices-platform ad3f6a65

Rotate a webhook signing secret ​

What It Does ​

Signing-secret rotation gives providers time to switch to a replacement. Local secret references change before provider re-registration is necessarily successful. A scheduled expiry removes the old reference after the overlap.

The Flow ​

When Something Fails ​

Reject disabled endpoints and an already rotating endpoint. No intended rotation begins on that refusal. A provider registration failure is recorded after local rotation. The provider can continue using the old signing secret; secret storage cannot roll back with the database. Apply the normal message failure and retry handling. Notification processing can still fail for unrelated verification reasons. A later pass repeats failed expiry work. Previous-secret acceptance lasts longer if the dispatcher is unavailable.

Open Design Questions ​

Provider re-registration and local secret updates do not form one transaction. A provider left on the old secret loses verification once overlap expires.

Controls

40 controls apply, from the corpus control catalogue.

TC-AVL-001 TC-AVL-004 TC-AVL-005 TC-AZ-001 TC-AZ-002 TC-AZ-003 TC-AZ-004 TC-CRY-001 TC-CRY-002 TC-CRY-003 TC-CRY-004 TC-DAT-001 TC-DAT-002 TC-DAT-003 TC-IAM-001 TC-IAM-002 TC-IAM-004 TC-IAM-005 TC-IAM-006 TC-LOG-002 TC-LOG-003 TC-LOG-004 TC-LOG-005 TC-MON-001 TC-MON-002 TC-PI-001 TC-PI-002 TC-PI-003 TC-PI-004 TC-PI-005 TC-SEC-001 TC-SEC-002 TC-SEC-003 TC-SEC-004 TC-TEN-001 TC-TEN-002 TC-TEN-003 TC-VEN-001 TC-VEN-002 TC-VEN-003

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.

Rhythm Software