Skip to content
raileonDocs

Search documentation

Find a guide in the Raileon documentation

Connect Karbon

Last updated

Connecting Karbon lets your Modules see your clients and the work your firm has in progress, and add notes to work items. You paste two keys from a Karbon API application, and Raileon keeps them encrypted.

What your Modules can do

  • Find a client by name, whether it is a person or a business.
  • List your work items with their status and due dates, soonest due first. You can narrow the list to one client or one team member.
  • Read one work item in full.
  • Add a note to a work item. Your Karbon team can see it. The note is written as the Karbon user whose email you give when you connect.

Reading never needs approval. Every note is held until you approve it, and the approval card shows the work item and client it will land on.

Your Modules cannot create or change work items, tasks, invoices or clients, and they cannot delete anything in Karbon.

Before you start

Karbon's API is available on the Business and Enterprise plans. You need to be able to open Settings, then Connected Apps, then API Applications in Karbon. If you do not see it, ask Karbon support to turn on API access for your firm.

Connect Karbon

  1. Open Apps

    In your dashboard, go to Apps in the left sidebar and select Connect on the Karbon card.

  2. Open your API application in Karbon

    In Karbon, open Settings, then Connected Apps, then API Applications, and open your application. If you do not have one yet, create it there.

  3. Copy the two keys

    Karbon shows a bearer token (the Application ID) and an access key, which is a long key that starts with eyJ. They are different, so paste each into its own box.

  4. Add the note author and test

    Enter the email of the Karbon user your notes should be written as, then select Test connection. Raileon checks the keys work before saving.

  5. Confirm it is connected

    The Karbon card shows Connected.

Private and hidden clients

By default Karbon's API only shows public clients. If your firm uses private or hidden clients and you want your Modules to see them, ask a Karbon admin to enable that for the API application in Karbon.

Disconnect Karbon

Open Apps, find the Karbon card, and select Disconnect. You can also rotate the keys in Karbon to cut off access right away.