Skip to main content

Integrations Overview

Sending data to COS, reading COS records and pulling measurements from an external API use different authentication flows.

NeedRouteAuthentication
Read COS business records or perform an authorized operationREST APIUser JWT; X-Tenant-ID for company-scoped requests
Send KPI/KR measurements from an external systemPush Measurement APIx-api-key; the key determines the company
Fetch measurements on a scheduleKPI API Integration (Pull)External-service credentials stored on the integration endpoint

Determine the API address​

Use your deployment's configured API base URL. Do not derive a tenant subdomain or /api/v1 prefix from the web address. Replace sample hostnames with your own API address. User roles and record scope also apply to REST calls.

Start with Push​

  1. Under Settings → API Keys, create a key for the sending system. This requires management authority and is subject to the effective key limit.
  2. Copy the key once when created and store it in the external system's secret store.
  3. Use the Push API section in the KPI detail to obtain the correct address, KPI ID and kpiType example.
  4. After the first push, verify the date and value in the KPI's Measurements tab.

A push key does not create a general REST session. Revoked, expired or unauthorized keys are rejected.

Start with Pull​

  1. Define the external-service connection under Settings → Integrations.
  2. In the KPI's Integration tab, bind that endpoint and configure the value/date mappings.
  3. Test the connection and inspect the run result. An unreachable address, or one blocked by the server's security policy, cannot provide measurements.

Follow the Pull guide for fields, JSONPath examples and errors. Use the Mock API guide for a test service.

Export​

CSV export from an OKR cycle's Health & Progress view downloads the rows currently visible. On other screens, use the export action actually offered by that screen and its guide. Do not assume a generic CSV user/resource import or an Excel/PDF menu for every module.

Keep integration keys out of conversations, source code and screenshots. Before connecting a system, agree with your organization on the outgoing fields, access scope and target server.

See also​