Developer centerAPI keys

API Results and Errors

Read Each Layer Separately

LayerWhat to inspectMeaning
ConnectionTimeout, network error, unreadable responseThe client cannot yet establish the operation result.
HTTPActual response statusTransport/request handling; does not replace the API result.
APIResult.Code and Result.Message when presentApplication-level processing result; interpret according to the returned contract.
SignalsReturned values and the configured modelDecision/model output, when supplied.
Business outcomeDisposition code and observed transaction/session stateWhat happened in the interaction, not an HTTP or API error code.

Handling Failures

  • Inspect the actual response before assuming an input, authorization, or service problem.
  • For authorization failures, verify the key scope and ActionKey type without exposing credentials in diagnostics.
  • For field errors, use the ActionType guide and field definitions.
  • For connection failures or timeouts, establish whether the event was received before retrying.
  • Preserve correlation identifiers and sanitize logs before sharing them with IH.

Use the provisioned integration contract for numeric result meanings and retry policy. Confirm whether a timed-out event was received before treating a retry as a new operation.

Related Documentation