Zapier, webhooks, and the API
Overview
Kompass is built to connect with the rest of your toolkit. Whether you want to sync organizations into another system, post a Slack message when an invoice is raised, or build a custom report, there are three ways to integrate, from no-code to full control:
- Zapier: connect Kompass to thousands of apps without writing any code.
- Webhooks: have Kompass push real-time notifications to your own endpoint when data changes.
- The API: read and write Kompass data directly from your own scripts and services.
Zapier and the API use a Personal Access Token (PAT); webhooks sign each delivery with a shared secret instead. Start with the token if you plan to use Zapier or the API.
Step 1: Create a Personal Access Token
Zapier and API integrations authenticate with a PAT, a secret tied to your user account that grants the same access you have in the web app.
- Sign in to Kompass and open Settings from your user menu.
- Select API Tokens in the Settings sidebar.
- Click Create.
- Give the token a recognizable name (for example Zapier or Reporting script), set an expiry, and choose its scopes. Click Create to create it.
- Copy the token immediately. It starts with
kmps_pat_and is shown only once.
Creating a token requires permission to create personal access tokens. If you do not see API Tokens, ask your administrator. Use a separate token per integration so you can revoke one without breaking the others. For full details, see Personal access tokens (PATs).
Option 1: Zapier (no-code)
The official Kompass BMS Zapier app lets you build automated workflows (Zaps) between Kompass and thousands of other apps, with no code.
Connecting
- In Zapier, create a Zap and search for Kompass BMS.
- When prompted to connect your account, enter your Kompass URL (for example
https://yourcompany.kompassbms.com, without/api/at the end) and your Personal Access Token. - Zapier verifies the connection and you are ready to build.
What you can automate
- Triggers (when something happens in Kompass): created, updated, and deleted events for organizations, contacts, projects, invoices, payments, proposal items, timesheets, expenses, time off, sales orders, and suppliers. Triggers fire instantly, powered by webhooks behind the scenes. Update triggers include a
changesfield showing exactly which fields changed. Timesheet and time off events fire only once the record is approved. - Actions (do something in Kompass): create, update, and delete the same record types from any other app.
- Lookups (pick a record in Kompass): record fields in the Zap editor are dropdowns backed by Kompass list endpoints, so you can choose an organization, contact, project, or other record in a later step.
Example: when a deal is marked Won in your CRM, create the organization and project in Kompass automatically. Or, when an invoice is created in Kompass, post a message to a Slack channel.
Note: if you cannot find the Kompass BMS app in Zapier, contact Kompass Support and we will share an install link.
Option 2: Webhooks (real-time push)
If you run your own service, webhooks are the most efficient way to react to changes: Kompass sends an HTTPS POST to a URL you control the moment data changes, so you never have to poll.
Subscribe to events such as project.create , invoice.update , or client.* . Each delivery is signed with HMAC-SHA256 so you can verify it genuinely came from Kompass, and failed deliveries are retried automatically.
This is the same mechanism that powers instant Zapier triggers, exposed directly for custom integrations. For setup, event types, payload format, and signature verification, see Webhooks.
Choosing Sync now on a client, contact, project, invoice, supplier or expense also sends a webhook update event for it. Sync now is offered on records that sync to at least one other integration that keeps a sync status. See Syncing records to your integrations.
Option 3: The API (full control)
For scripts, reports, and custom integrations, talk to the REST API directly. The API is the same one the web app and Zapier use, so anything you can do in Kompass you can do through it (subject to your permissions).
Base URL and authentication
The API lives under /api/ on your instance, for example https://yourcompany.kompassbms.com/api/ . Send your token in the Authorization header on every request:
Authorization: Bearer kmps_pat_your_token_here
Interactive documentation
Every instance ships with live, auto-generated API documentation. The interactive consoles require a Kompass sign-in; for a public read-only reference, see support.kompassbms.com/api/.
/api/docs/interactive reference/api/schema/the raw OpenAPI schema (import this into Postman, Insomnia, or a code generator)
Main resources include organizations (clients), contacts, projects, proposal items (quote-items), tasks, timesheets (diary), expenses, invoices, payments, time off (leave), and users.
Example request
curl https://yourcompany.kompassbms.com/api/clients/ \ -H "Authorization: Bearer kmps_pat_your_token_here"
Prefer the command line?
The first-party Kompass CLI wraps the API with predictable subcommands (kompass clients list , kompass projects create , and so on) and stable JSON output, which is ideal for automation and scripting. It authenticates with the same PAT via the KOMPASS_TOKEN environment variable. See Kompass CLI.
Which option should I use?
| If you want to… | Use |
|---|---|
| Connect Kompass to another SaaS app without code | Zapier |
| React to changes in your own service in real time | Webhooks |
| Read or write data from a custom script or report | The API (or the CLI) |
Getting help
If you are planning an integration and want to talk it through, or you need access to the Zapier app, contact Kompass Support.