Set up the Codemeta OS integration

Connect Codemeta OS to octoja to raise tickets from check alerts, sync devices, and import customers using a Codemeta OS API key and your Workspace ID.

Written By Stefan Steuer

Last updated 26 days ago

Set up the Codemeta OS integration

Codemeta OS is a service-desk and CRM platform. When you connect it to octoja, octoja can raise Codemeta OS tickets from check alerts, keep your device inventory in sync, and import customers from Codemeta OS so tickets land on the right customer. The connection is built in two halves: you create an API key and read your Workspace ID inside Codemeta OS, then enter both in octoja and configure the mapping.

Prerequisites

  • The Integration Management permission in octoja. Administrators assign permissions to groups under Administration → Groups.
  • A Codemeta OS account with administrator access — enough to create an API key in the API console and to read your Workspace ID.
  • For a self-hosted Codemeta OS instance: the API base URL of that instance. The cloud service at https://os.codemeta.de/api/v1 is the default and needs no override.

Step 1 — Create an API key in Codemeta OS

  1. In Codemeta OS, open the API-Konsole and click Neuen Schlüssel erstellen.
The Codemeta OS API console (API-Konsole) with the Schlüssel, Aktivität, and Playground tabs, showing the API-Schlüssel section and the green "Neuen Schlüssel erstellen" button top right.
  1. Give the key a name (for example octoja RMM) so you can recognise it later.
  2. Choose the Live environment for production use.
  3. Enable the GET, POST, PATCH, and PUT HTTP methods. octoja reads and writes data, so read-only (GET) alone is not enough.
  4. Select the permissions the integration needs. The recommended scopes cover device templates, assets/CMDB, sites, messages, CRM/contacts, RMM devices, RMM device inventory, ticket types, and tickets — everything octoja touches when it syncs devices, imports customers, and raises tickets.
  5. Click Schlüssel erstellen.
The "Neuen API-Key erstellen" dialog in Codemeta OS — a Bezeichnung field set to "octoja RMM", the Live environment selected, the GET/POST/PATCH/PUT HTTP methods enabled, and a Berechtigungen permission picker.
  1. Codemeta OS shows the token once. Click Token kopieren and paste it somewhere safe — a password manager or secret store. You will paste it into octoja in Step 3. If you lose it, you cannot view it again; create a new key instead.
The "Schlüssel wurde erstellt" confirmation in Codemeta OS showing the one-time token in a green box, a "Token kopieren" button, a curl usage example, and a checkbox confirming the token was stored safely.

Step 2 — Find your Tenant ID (Workspace ID)

octoja identifies your Codemeta OS tenant by its Workspace ID.

  1. Open the user menu in the bottom-left corner of Codemeta OS and click Profil.
The Codemeta OS user menu expanded, showing Status setzen, Profil (highlighted), Verwaltung, and Abmelden, above the signed-in administrator account.
  1. In Einstellungen, open the Workspaces tab. Each workspace card shows a Workspace-ID. Copy the ID of the active workspace — this is the Tenant ID you will enter in octoja.
The Codemeta OS Einstellungen page on the Workspaces tab, showing the active "octoja DEMO" workspace with its Rolle, Registriert date, and the Workspace-ID used as the Tenant ID.

Step 3 — Connect in octoja

  1. In octoja, go to Administration → Integrations and open Codemeta OS.
  2. In the Set up Codemeta OS dialog, fill in:
FieldWhat to enter
API tokenThe token you copied in Step 1
Tenant IDThe Workspace ID from Step 2
Base URL (optional)Only for a self-hosted Codemeta OS instance. Leave blank to use the cloud service
  1. Click Test connection to verify the credentials, then Connect to save the connection.
The "Set up Codemeta OS" dialog in octoja with an API token field, a Tenant ID field, an optional Base URL field for self-hosted instances, and "Test connection" plus "Connect" buttons.

Step 4 — Configure the integration

After connecting, the Configuration tab opens. Work through the three sections and then save.

  • Customer mapping — map your octoja customers and sites to their Codemeta OS counterparts so tickets land on the right customer. Use Match customers and Match sites, or let octoja auto-match with the wand icon.
  • Ticket mapping — pick the ticket type Codemeta OS tickets use, and the priorities octoja applies for Warning and Critical alerts.
  • Device sync — map each octoja device type (Windows Server, Windows Workstation, Linux Server, Linux Desktop, macOS) to a Codemeta OS asset type. octoja matches devices by hostname per customer/location, creates the ones that are missing, and leaves existing devices untouched. Turn on Automatically sync devices hourly for an hourly sync.

Click Save settings to apply the configuration.

The Codemeta OS integration page in octoja on the Configuration tab, with Customer mapping, Ticket mapping (ticket type and priorities), and Device sync (device-type mapping and an hourly auto-sync toggle) sections.

Track activity

The History tab lists every ticket-creation and recovery attempt octoja sends to Codemeta OS under Recent deliveries, so you can confirm deliveries and troubleshoot failures.

The Codemeta OS integration page in octoja on the History tab, showing the "Recent deliveries" delivery log that records each ticket-creation and recovery attempt.

What you can do now

  • Import customers from Codemeta OS into octoja.
  • Raise Codemeta OS tickets automatically from octoja check alerts.
  • Log time from remote-control sessions or remote actions against a Codemeta OS ticket.
  • Create devices in Codemeta OS from octoja.

Tips

  • Restrict the API key to the permissions listed above — no more. You can rotate it anytime in the Codemeta OS API console and paste the new token into octoja.
  • The device sync matches on hostname per customer/location. Make sure your customer mapping is correct first, or devices may be created under the wrong customer.
  • Existing Codemeta OS devices are never overwritten — the sync only fills in the ones that are missing.