Skip to content

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

  1. Choose the event

    Start with a customer record, case, approved answer, or staff handoff.

  2. Confirm the contract

    Record the operation, permission, workspace source, and fields your server will send.

  3. Test failure first

    Exercise unauthorized, invalid, conflict, rate-limit, and temporary-service outcomes.

  4. Trace completion

    Keep the request ID and connect the API result or webhook to the resulting work.

Request and result

Example read request
GET /knowledge/facts
Authorization: Bearer <server-token>
X-Workspace-Id: <workspace-id>
What your integration must retain
HTTP 200
X-Request-Id: req_...

{ "items": [], "nextCursor": null }

Failure handling

API failure handling
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

Do not send credentials, customer secrets, or raw payment data. Include the contract version, environment, operation, timestamp, and non-sensitive correlation ID.