API and webhooks
Your own API keys with individual permissions, REST API at /api/v1 and signed webhooks on changes.
With the open API you connect AuftragsDesk with your own systems, such as an ERP, a ticket system or tools like n8n. You find it under Administration → Integrations → API and webhooks.
Creating an API key
- Click New API key and give it a name.
- Choose permissions individually: read orders, create orders and change status, read customers, create customers, read clients.
- Optional: an expiry date.
- Copy the key (it starts with
adk_). It is shown only once.
You can revoke a key at any time. If you revoke the last valid key, AuftragsDesk also pauses your webhooks so that no more data goes to the system you switched off; you can switch them back on under Webhooks.
The REST API
The API lives at /api/v1 and is called with the key in the header Authorization: Bearer adk_….
| Endpoint | Function |
|---|---|
| Orders | read (filter by status, change time, client, customer, reference; paged), create, change status |
| Customers | read and create |
| Clients | read |
Status changes follow the same rules as in the application. The full reference is in the Swagger UI at /api-docs/ui.
Webhooks
A webhook reports changes via HTTPS POST to an address of your choice:
auftrag.angelegt, auftrag.geaendert, auftrag.status_geaendert, auftrag.abgeschlossen, kunde.angelegt, kunde.geaendert, kunde.geloescht
- Each message is signed with HMAC-SHA256 (header
AuftragsDesk-Signatur). - If delivery fails, AuftragsDesk retries up to eight times over just over two days.
- The delivery log shows every attempt. "Send test" and "Resend" help during setup.
Treat API keys like passwords. Addresses in private networks (e.g.
localhost) are blocked as webhook targets, and an address unreachable for five days is paused.
API for your customers
Your customers can also connect their customer portal via API, with their own keys that only see their data. See Customer portal API.