The WorkHub API lets other software read your workspace's data: people, attendance, leave, logged time, projects and tasks, your CRM, and invoices to clients. Keys with Read and write access can also add and change tasks, leads, contacts and activities, for example to send your website's enquiries straight into your leads. It's part of the Business plan.
Create a key (owners and admins)
- Open Settings → API.
- Give the key a name that says what it's for, such as "Payroll sync". Choose Read only unless the software needs to change data. Then choose Create key.
- Copy the key and give it to whoever is setting up the connection. It's shown only once.
What a key can see
A key acts as the person who created it, with their access, in this workspace only. If that person leaves or stops being an admin, the key stops working and Settings → API says so. Create keys from an account that will stay.
If a key leaks
Choose Revoke next to it in Settings → API. Anything using it stops at once. Then create a new key.
Webhooks: tell another system when something happens
A webhook sends a message to another system the moment something happens in WorkHub: someone checks in, leave is requested or decided, a task is created or completed, a lead is added, a deal is won or lost, or an invoice is paid.
- In Settings → API, choose Add a webhook.
- Paste the address the other system gave you (it starts with https://) and tick the events it needs.
- Copy the signing secret into the other system. It's shown once, and lets that system check each message really came from WorkHub.
- Choose Send a test to check it works.
If the other system stops answering, WorkHub keeps trying for about a day, then pauses the webhook and emails the workspace's owners. Nothing is lost: events wait, and are sent when you choose Resume. Deliveries shows the last 25 messages and how each went.
For developers: see the API documentation.