Send a UUID v4 or v7 in X-Request-ID on every request attempt.
If supplied, the API returns the identifier unchanged. If omitted, JobHandy generates one and returns it in the response.
Purpose
A request ID links:
- the client attempt
- the API response
- customer logs and metrics
- JobHandy diagnostics
- a support case
Validation
The value must be a UUID v4 or v7. Invalid values fail with INVALID_REQUEST_ID.
One attempt, one request ID
Generate a new request ID for every HTTP attempt. Link retries using an internal logical-operation ID in your own telemetry.
Not an idempotency key
X-Request-ID does not:
- deduplicate requests
- guarantee exactly-once execution
- make
POST or state transitions safe to replay
- prove that a timed-out write was not applied
After an ambiguous write outcome, re-read the affected resource before deciding whether another write is required.
Logging recommendation
Log:
- UTC timestamp
- method and path template
- tenant context
- HTTP status
- API error code
- request ID
- retry attempt number
- internal logical-operation ID
Do not log the API key or unnecessary personal payload data. Last modified on August 28, 2026
