Zapier, webhooks, and the API

Overview

Kompass is built to connect with the rest of your toolkit. Whether you want to sync clients 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 6,000+ 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.

All three use the same authentication method: a Personal Access Token (PAT). Start there.

Step 1: Create a Personal Access Token

Every integration authenticates with a PAT, a secret tied to your user account that grants the same access you have in the web app.

1. Sign in to Kompass and open Settings from your user menu.
2. Open the API tokens tab.
3. Click Create token, give it a recognisable name (for example Zapier or Reporting script), and set an expiry.
4. Copy the token immediately. It starts with kmps_pat_  and is shown only once.

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

1. In Zapier, create a Zap and search for Kompass BMS.
2. 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.
3. 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 clients, contacts, projects, invoices, payments, quote items, diary entries, expenses, leave, and suppliers. Triggers fire instantly, powered by webhooks behind the scenes. Update triggers include a changes  field showing exactly which fields changed. Diary and leave 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.
• Searches (find something in Kompass): look up an organisation or client to use in later steps.

Example: when a deal is marked Won in your CRM, create the client and project in Kompass automatically. Or, when an invoice is created in Kompass, post a message to a Slack channel.

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.

Option 3: The API (full control)

For custom scripts, reports, and bespoke 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 you can browse and try out:

• /api/docs/  interactive reference
• /api/schema/ the raw OpenAPI schema (import this into Postman, Insomnia, or a code generator)

Main resources include clients, contacts, projects, quote items, tasks, diary entries, expenses, invoices, payments, 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?

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.