API keys and webhooks

For companies with their own developers. The API lets other software read and change Punchly data. Webhooks tell other software the moment something happens.

Plan

Free. Paid plans allow more requests

Documentation

docs.punchly.work

Workspace API keys

For connecting a tool to the whole workspace, such as payroll or reporting. Owner and admins create them in Workspace settings, Integrations, under API keys.

  1. Press Create key and give it a name.
  2. Choose what it can do: Read-only, Full access, or Custom, area by area.
  3. Choose when it expires: never, or in 30 days, 90 days or a year.
  4. Copy the key. It is shown only once.

A key can be revoked at any time. Anything using it stops working at once.

Personal API keys

In your profile, on the Advanced tab. A personal key can do whatever you can do, in every workspace you belong to. Treat it like a password.

Webhooks

Also in your profile, on the Advanced tab. A webhook sends a message to an address of yours when something happens in Punchly.

  • Give it a name, the address to call, and tick the events: time entries, timers, clock-ins, projects, approvals, time off, expenses, invoices and more.
  • Choose whose activity: only your own, or everybody’s (owner and admins).
  • Each message is signed with a secret, so your software can check it really came from Punchly.
  • If your address does not answer, Punchly tries again several times. After 20 failures in a row the webhook is switched off and you are told. You can switch it back on.
  • A log shows every delivery, and lets you send one again.

Limits

  • 60 requests a minute per key on the Free plan, and 600 on paid plans.
  • Up to 50 workspace keys per workspace.