A webhook fails against an old schema; establish the version, approve corrections and replay with deduplication.
Integration governance
Authorize integrations and release them to production against approved contracts, certificates and tests.
Inputs and starting conditions
OAuth clients/scopes, contract status, credentials/certificates, webhook endpoints, quotas and test evidence.
Workflow and control gates
- 01Register client
- 02Approve scopes / contract
- 03Test callbacks / failures
- 04Approve production
- 05Rotate and audit
A proposed contract is not an available API. Test overlap/revocation during rotation; mTLS authenticates channels but does not replace business authorization. Webhooks require signatures, replay policy and audit.
Exceptions and recovery
Exhausted webhook retries move to an exception queue; replay retains eventId and approval authority. Exposed credentials require revocation/rotation and impact review; never log secrets.
Roles, outputs and states
| Responsibilities | Evidence and states |
|---|---|
| Developers register; organization/security teams approve scopes; platform teams operate; owners accept integrations; audit checks contract/version. | Contract/version/status, client approvals, certificate history, retry/replay logs and production approvals. States: proposed → review → tested → approved according to actual evidence. |
Scenario and acceptance criteria
Complete only when
An HTTP success alone does not close the incident.
Interfaces for this workflow
Integration handoff
End-to-end integration workflows
Connect technical states to business decisions instead of merely listing endpoints.
Read detailsOpenAPI and Swagger Reference
The proposed contract is rendered from one local specification; no network Try-It or real credentials.
Read detailsErrors and next actions
A consistent error envelope guides recovery without disclosing sensitive data.
Read detailsContinue the workflow
Integration quickstart
Exercise ingest → job tracking → registration → verification with synthetic data.
Read detailsTwo journeys, one records lifecycle
Connect paper and born-digital records through persistent identifiers, policies and evidence.
Read detailsIntegrity, provenance and evidence
Each evidence type answers a different question; hashes, timestamps and approvals are not interchangeable.
Read detailsStart with a verifiable scope.
Agree record classes, quality criteria, permissions and evidence before scaling.
Plan assessment