Skip to main content

How to use the Kraaft API πŸ”Œ

The Kraaft API lets you connect your Kraaft workspace to your other tools and automate your workflows: no more double data entry β€” just smart connections πŸ’‘!


πŸ“Œ What is the Kraaft API?

The Kraaft API is a technical interface that lets your external tools communicate directly with Kraaft πŸ’‘ In practice, you can trigger actions automatically, with no manual input.

Here are some examples of what you can do:

  • πŸ—οΈ Automatically create a Kraaft conversation from your ERP when a project is launched

  • πŸ“‚ Archive your reports to SharePoint, Google Drive or your DMS as soon as they're complete

  • πŸ”” Trigger an action in an external tool as soon as a report changes status in Kraaft


β˜‘οΈ Step 1: Activate the API on your Kraaft workspace

The Kraaft API isn't enabled by default βš™οΈ To get access, contact our support team.

⚠️ Only an account owner can request activation.

πŸ”‘ Step 2: Create a Kraaft API key

Once the API is activated, the administrator or owner of the workspace can create keys from the settings.

  1. Go to the Menu β†’ Settings of your workspace

  2. Click on the API Keys tab πŸ”‘

  3. Click "Create an API key" βž•

  4. Give it a meaningful name (e.g. "Make - ERP" or "Zapier - Archiving") πŸ“‹

  5. Choose the role for the key based on your use case

The available roles:

Role

Rights & access

When to use it?

Standard

Access only to conversations the key has been manually added to

Targeted use on specific conversations

Administrator & Owner

Full access to the workspace, creation and modification

Classic use for a global integration

⚠️ The key is shown only once β€” copy it immediately! If you lose it, you'll need to create a new one (takes 2 minutes, but better to avoid it πŸ˜…)


πŸ“¦ What you can do with the Kraaft API

The API is built around 4 resources:

  • πŸ—‚οΈ Workspaces β€” list the workspaces accessible with your key

  • πŸ“‹ Schemas β€” read the structure of your reports to know what to send and receive

  • πŸ“ Records & Conversations β€” list, read, create and update your reports and conversations

  • ⚑ Events β€” detect everything happening in Kraaft in real time

⚑ Spotlight on Events πŸ”

Kraaft keeps a log of everything that happens: every report created, updated or deleted generates an event πŸ”” Two ways to consume them:

  • Event list β€” query Kraaft at regular intervals ("what happened since last time?")

  • Real-time events β€” receive events instantly as they happen ⚑

πŸ’‘ Example: your ERP is automatically notified as soon as a report changes to "Done" status in Kraaft β€” with no manual action needed.

❌ What's not yet possible: sending messages or files via the Kraaft chat.


πŸ€– Using the Kraaft API with an automation tool

Want to connect the Kraaft API to a no-code tool? Absolutely possible πŸŽ‰

  • βœ… Make: native Kraaft connectors are available directly in Make

  • πŸ”§ Zapier, n8n and others: use the HTTP or API request modules in your tool to call the Kraaft API

  • πŸ”œ More native Kraaft connectors will be available in other tools in the future


πŸ“– Access the Kraaft API documentation

The official documentation is available here πŸ‘‰ developers.kraaft.co/docs

It details all available endpoints, expected data formats and authentication methods πŸ“š A technical profile will find their way around quickly!


πŸ“Š Want to analyse your Kraaft data?

The Kraaft Data Exchange (KDE) is made for that πŸ“Š Connect your data to Power BI, Tableau or Looker β€” and manage your projects from a single data visualisation tool.

πŸ‘‰ Discover KDE


πŸ’¬ Need help?

Did this answer your question?