Developer resources
Prove one customer action before connecting the next system.
Connect one approved customer action with explicit authentication, workspace scope, permission, retry, error, and audit behavior.
Implementation checklist
Choose the event
Start with a customer record, case, approved answer, or staff handoff.
Confirm the contract
Record the operation, permission, workspace source, and fields your server will send.
Test failure first
Exercise unauthorized, invalid, conflict, rate-limit, and temporary-service outcomes.
Trace completion
Keep the request ID and connect the API result or webhook to the resulting work.
Request and result
GET /knowledge/facts
Authorization: Bearer <server-token>
X-Workspace-Id: <workspace-id>HTTP 200
X-Request-Id: req_...
{ "items": [], "nextCursor": null }Failure handling
| Status | Meaning | Client action |
|---|---|---|
| 401 | Credential is missing, expired, or invalid | Stop; refresh through the approved server flow. |
| 403 | Identity lacks the exact permission or scope | Do not retry; request an access review. |
| 409 | State, version, idempotency, or approval conflicts | Read the conflict and reconcile before another command. |
| 422 | The request does not match the published schema | Correct the named fields; do not retry unchanged. |
| 429 | The integration is sending too quickly | Honor the supplied wait guidance and apply backoff. |
| 5xx | A temporary service failure may have occurred | Preserve IDs; retry only when the operation permits it. |
Implementation support
Do not send credentials, customer secrets, or raw payment data. Include the contract version, environment, operation, timestamp, and non-sensitive correlation ID.