Skip to content
Browse the docs

Company API Keys, Admin API and Webhooks

Create company API keys with admin scopes, revoke members' connected apps, and send summaries and member events to your systems with webhooks.

The area Integrations & API holds your company's API keys, the apps members connected to their company accounts, and your webhooks. API keys and webhooks are available on the Team and Enterprise plans.

Owners and admins manage API keys and webhooks. Member admins (and, on Enterprise, custom roles with Manage members) see only Connected apps.

API keys

Company API keys are for your own programs and scripts that call the Kalima public API. See REST API.

1
Under API keys, choose Create key.
2
Enter a Name so you recognize the key later.
3
Pick Permissions: Read (fetch recordings, transcripts, summaries, projects and exports) and/or Write (upload, rename and move recordings, create projects, name speakers, create summaries and share links).
4
Pick how long it is Valid for: 30, 90, 180 or 365 days, or No expiry.
5
Choose Create and copy the key. Kalima shows it only once. Your program sends it with every call in the Authorization: Bearer header.

Good to know:

  • A key acts on behalf of the person who created it and sees only what that person sees in Kalima.
  • If that person is suspended, the key is Paused until the suspension is lifted. If they leave the company, the key no longer works.
  • Your plan must include access to the public API, and it limits the number of keys. The list shows how many you use.
  • If Zapier and the public API or API keys is turned off in Policies, no key can be created and the API refuses existing keys.
  • Revoke stops a key for good.

Company administration (admin API)

When you create a key, the section Company administration lets your own programs manage your company over the API, for example if you do not use SCIM. For Members, Teams and Policies you choose No access, Read or Read and change:

  • Members: fetch members; with Read and change also invite people, change roles, suspend and reactivate.
  • Teams: fetch teams; with Read and change also create and rename teams, add or remove people and set the team lead. Teams cannot be deleted through the API.
  • Policies: fetch the policies; with Read and change also change them, except the deletion rules (Delete recordings automatically, Delete audio separately and zero data retention).

Limits of admin scopes:

  • Only owners and admins can give a key admin scopes. The key acts with their rights, and only while they hold that role.
  • There is no second-factor check for each change. Every change appears in the audit log under the key's name.
  • Admin scopes give no access to recordings.
  • If allowed networks apply to the console, they apply to the admin API too.

Keep such a key as safe as a password.

Connected apps

Connected apps lists the AI apps (such as Claude and ChatGPT), other MCP clients, and Zapier, Make and n8n that members connected to their company account, with the person and the app. An app sees only what the person sees in Kalima. What private accounts connect is not visible to the company.

Choose Revoke to end a connection. The app gets no more data from that account from its next request on. The person can connect it again as long as your policies allow it.

Webhooks

Webhooks send your company's events to HTTPS addresses of your choice. Choose Manage webhooks, then Add webhook. Owners and admins manage them.

1
Enter a Name and the Address: an HTTPS address that accepts POST requests with JSON, on port 443 or a port from 1024.
2
Pick the Events.
3
Copy the signing secret and store it at the receiver. Kalima shows it only once.
4
Choose Test to send a single test event.

Events

EventWhenWhat it contains
Summary ready (summary.ready)A summary is ready or changedRecording ID, title, team and project, and the summary text with its language. Never audio, never the transcript.
Member joined (member.joined)An invitation is accepted or SCIM creates an accountUser ID, email address and role
Member removed (member.removed)Someone is removed, leaves or their membership ends. A suspension does not count.User ID, email address and role

Which recordings send summaries

Kalima sends Summary ready only for recordings your teams can already see: in a team workspace, or in a project that was shared with a whole team (also in its sub-projects). Kalima never sends private recordings or recordings shared only with single people or by link. It checks this when the summary is saved and again right before sending.

  • A summary text over 100,000 characters is cut.
  • If your policies do not allow Export for members, or not in the Markdown summary format, the event arrives without the summary text.

Delivery and signature

  • Up to 5 addresses per company. Kalima only sends to public addresses and does not follow redirects.
  • Every request carries the Kalima-Signature header with a timestamp and an HMAC-SHA256 signature over the timestamp and the body. Reject requests whose timestamp is more than five minutes old. Create new secret replaces the secret at once.
  • Events usually arrive within a minute. Kalima delivers every event at least once; duplicates can be told apart by their id.
  • If the receiver does not answer with a 2xx status within 10 seconds, Kalima retries up to ten times, at growing intervals of up to an hour. If delivery fails for 24 hours, Kalima pauses the address. Events from the time of a pause are not sent later.
  • Deliveries shows the last 50 deliveries without their content. Kalima deletes entries after 30 days.
  • Webhooks are off while Zapier and the public API is turned off in your policies. Events from that time are not sent later either.