Connect the Desk to the tools you already use
Step-by-step guides for every connection the Desk offers: what to prepare at the provider, what to press, how to check that it works. And the API, for the connections you build yourself.
Mail, messengers, couriers, card payments, Shopify, accounting and ERP systems. 14 guides.
For developers and agentsCRM and ERP APIA service key, draft orders, deal links, signed events and an n8n example.
Set-up guides
Every guide is the text an admin reads inside the Desk, under Help → Connections. A guide marked Own deployment is for a Desk you run yourself: a hosted workspace does not have that page.
Channels
Mailboxes
The company mailbox, team and personal mailboxes, Google and Microsoft sign-in.
A WhatsApp Business number through Meta, and the 24-hour rule for replies.
Instagram and Facebook
Direct messages and Messenger chats of your pages in the sales inbox.
Telegram
A bot made in BotFather that carries customer chats into the inbox.
A WeChat service account and what to enter on each side.
Website Chat
The chat window on your own website and the one line that puts it there.
Orders and money
Couriers
DHL Express, UPS and FedEx on your own accounts: live rates on an order.
Card payments · Stripe
Own deploymentA payment link on proformas and invoices, through your own Stripe account.
Shopify
Own deploymentYour store and the Desk: what moves between them, and whose each record is.
Accounting and ERP
Accounting systems
Zoho Books and Xero: documents go in, payments are read back.
ERP systems
Own deploymentThe Desk on top of the ERP you already run: the rules and how to connect.
Workspace
CRM and ERP API
Use the Terramine Desk API to request draft orders, link deals to your ERP, and receive signed events in your automations.
Make your first API requestExplore the API
Start with your workspace
You need your workspace URL and a service key created by its owner. Available operations depend on the enabled modules and installed release. Check /api/v1/openapi.json on your workspace before connecting. An admin creates the key in the Desk: API keys and webhooks.
Set up API access
Create a service key, look up a customer, and check the response.
Build an n8n workflow
Import the example and create a draft using records from your workspace.
Request a draft from your CRM
Create a sales order for pricing in Terramine and track the sent quotation.
Link an order from your ERP
React to a deal stage change and attach the confirmed order number and link.
Build and operate your integration
Build AI agent tools
Map tool calls to API operations and scopes. Keep credentials and retry decisions in your runner.
Receive signed events
Verify webhook signatures, record deliveries, and recover without duplicate actions.
Troubleshoot a request
Check errors, request limits, and steps to recover from a timeout.
Review API changes
Read the release history and compatibility policy for v1.
Reference and downloads
API reference
Browse all six operations and webhook schemas in Swagger UI.
OpenAPI 3.1
Download the published contract for client generation and validation.
Customer example kit
Run a local simulation, then connect your workspace with a standalone Python client.
n8n workflow
Download the draft-order example. Configure your own workspace and credentials.
AI documentation index
Find the Markdown guides and machine-readable contract for your agent tools.
Working on the Terramine source? The local development guide covers a disposable environment with synthetic records. It requires access to the private source repository. For customer integrations, follow the quickstart using your own workspace.
Tell us what you run and what should move. We will say what the API covers today and what a connection would take.