Skip to content
5sDesk

Feature · API & webhooks

5sDesk works with the rest of your systems

Contacts from your ERP system land in your customer base without retyping, a request from your online shop becomes a ticket, and a won order reports to the accounts team. The REST API and webhooks are included in Basic and Pro.

Start free trial

30-day trial · cancel free of charge during the trial · every module in every plan

API keys with permissions and expiry, next to the link to the OpenAPI documentation
  • REST API v1 with a complete OpenAPI description, open to anyone
  • Keys with exactly the permissions a connection needs, with an expiry, revocable one by one
  • Webhooks with a signature and retries when something is down

In detail

What the API can do

REST API with an OpenAPI description

Read and write tickets, messages, customers, companies, cards and deals. The complete description of every function is open to anyone, even before you sign up, and always up to date. If a connected system repeats a request because a reply was lost on the way, still only one ticket is created.

  • OpenAPI documentation readable without signing in
  • Protection against duplicate entries on retries
  • The ticket history shows which connection did what
Go to the API documentation
Base URL of the API

Keys with exactly the permissions they need

An access key is created in the settings with exactly the permissions the connection in question needs: reading only, customer data only, deal cards only. Every key can be named, given an expiry and revoked individually without disturbing the other connections.

  • Finely scoped permissions per key
  • Expiry and individual revocation
  • Stored encrypted
New API key with exactly the permissions it needs

Webhooks: 5sDesk reports in, instead of being asked

You store an address and choose what you want to hear about: new tickets, incoming messages, changed customer data, moved deal cards. Every message is signed, so your system can be sure it comes from 5sDesk. If your system is briefly unreachable, the message is retried several times, and the log shows you what was delivered.

  • Events chosen per webhook
  • A signature on every message
  • Retries and a delivery log
Creating a webhook target with events and a note on the legal basis

Works with

Works hand in hand with these features

Who it is for

Especially valuable for

Frequently asked questions

Which plans include the API and webhooks?
Basic and Pro. Starter includes every module but no API access.
Where do I find the API documentation?
Publicly at docs.5sdesk.com/api/docs, as an OpenAPI description that always matches the current state. The guide to API keys shows how to create keys in the settings.
How do I connect 5sDesk to our ERP system?
Through the REST API for customer master data and tickets, and through webhooks for events such as a won deal. If you have no developers of your own, use an integration platform that talks to REST APIs and webhooks.
How secure are the webhooks?
Every message is signed; your system checks the signature and knows the message comes from 5sDesk. Delivery attempts are logged and retried when something is down.

Connect instead of retyping

Create a key, set up your first webhook. Try it for 30 days in Basic or Pro.

Start free trial

30-day trial · cancel free of charge during the trial · every module in every plan