Observability

To enable us to support you with issues, by pinpointing exact requests and the api client version you are using, please include a standardised User-Agent header in every request. The User-Agent value is captured as a tag on API spans within our Application Monitoring.

Format

<organisation>-<system-name>/<version>

Examples

  • acme-payroll-service/1.4.2
  • contoso-hr-platform/2.0.0

Requirements

  • organisation: Your company or organisation name (lowercase, hyphenated if required)
  • system-name: The name of the calling system or service
  • version: The version of the calling system (semantic versioning recommended)

Best Practices

  • Keep values consistent across all environments
  • Increment the version with each release
  • Avoid generic or default User-Agent values (e.g. PostmanRuntime, curl)
Authentication
The Basics