Skip to content

API key

API key credentials attach a secret key either as a custom HTTP header or a query parameter — common for vendor APIs that do not use Bearer format.

  1. CredentialsCreateAPI key.
  2. Name — e.g. Weather API production.
  3. Key value — your secret.
  4. Location — header or query.
  5. If header: set Header name (e.g. X-Api-Key, api-key).
  6. If query: set Query parameter name (e.g. api_key, key).
  7. Save and link from Attach credentials.
SettingValue
LocationHeader
Header nameX-Api-Key
Sent asX-Api-Key: <secret>
SettingValue
LocationQuery
Param nameapi_key
ResultGET /v1/data?api_key=<secret>&city=London

Business query params (dates, filters) are separate — Chatevo merges them at runtime.

  • Prefer header over query when your API supports both (query keys appear in access logs).
  • Never document the key in tool descriptions.
  • Use different keys per environment.