Example read request
GET /knowledge/facts
Authorization: Bearer <server-token>
X-Workspace-Id: <workspace-id>Developer starting point
Build on Saleringo contracts
Connect one approved customer action with explicit authentication, workspace scope, permission, retry, error, and audit behavior.
CONTRACT WORKBENCHSERVER → SALERINGO
POST
/cases- Permission
- case.create
- Test first
- failure paths
- Workspace
- explicit
- Proof
- request ID
Prove one customer action before connecting the next system.
IMPLEMENTATION OUTCOME
Prove one customer action before connecting the next system.
Your approved deployment determines the origin, credentials, operations, data region, and available events.
- 1 · Choose the eventStart with a customer record, case, approved answer, or staff handoff.
- 2 · Confirm the contractRecord the operation, permission, workspace source, and fields your server will send.
- 3 · Test failure firstExercise unauthorized, invalid, conflict, rate-limit, and temporary-service outcomes.
- 4 · Trace completionKeep the request ID and connect the API result or webhook to the resulting work.
REQUEST → RESULT
Keep the request, result, and evidence together.
What your integration must retain
HTTP 200
X-Request-Id: req_...
{ "items": [], "nextCursor": null }RECOVERY CONTRACT
A retry is not the answer to every failure.
StatusMeaningClient action
401Credential is missing, expired, or invalidStop; refresh through the approved server flow.
403Identity lacks the exact permission or scopeDo not retry; request an access review.
409State, version, idempotency, or approval conflictsRead the conflict and reconcile before another command.
422The request does not match the published schemaCorrect the named fields; do not retry unchanged.
429The integration is sending too quicklyHonor the supplied wait guidance and apply backoff.
5xxA temporary service failure may have occurredPreserve IDs; retry only when the operation permits it.
IMPLEMENTATION SUPPORT
Bring one operation. Leave with the next test your team can run.
Do not send credentials, customer secrets, or raw payment data. Include the contract version, environment, operation, timestamp, and non-sensitive correlation ID.