Developers
Create API keys and OAuth clients with limited permissions, configure webhooks, and inspect webhook delivery logs.
Available from the Starter plan.
What this screen is for
The Developers portal provides technical tools for integrating Dawmly with external systems like ERPs, payroll engines, or custom workflows. It allows organization administrators to create API keys and OAuth clients, choose exactly what each one may read or write, register HMAC-secured webhook endpoints, send test event payloads, and inspect real-time webhook delivery logs.
The screen at a glance

- API Keys tab includes a creation form with a name and a Permissions picker, and a table listing keys with Name, Prefix, Permissions, Created by, Created, Last Used, Status, and Revoke action.
- OAuth clients tab lets a system exchange a client ID and secret for short-lived access tokens, so the secret is not sent with every request. Its table shows the client name, Client ID, Permissions, Created by, status and a Revoke action.
- Permissions picker groups permissions as Employees, Leave, Attendance and Payroll, each as Read or Write. Payroll read sits apart under Sensitive access, with a warning.
- Webhooks tab allows registering HTTP callback endpoints with signing secrets and choosing events grouped by area: Attendance, Leave, Employees, Payroll, Shifts and Field visits.
- Webhook panels and test action display configured endpoints with event chips, edit/delete controls, and a Send test ping button.
- Delivery history table expands under each webhook to inspect past delivery attempts, HTTP response codes, timestamps and retry statuses. Show payload opens the exact JSON body that was sent.
How to create an API key
- Navigate to the API Keys tab.
- Enter a descriptive Key name (e.g., "ERP Integration").
- In Permissions, tick what the integration needs. You must choose at least one. Departments, positions and branches follow the Employees permissions.
- Click Create API Key.
- In the dialog that appears, copy the full secret API key immediately and store it securely (it will never be displayed again).
Give each integration its own key with only the permissions it needs, so you can revoke one without touching the others.
How to create an OAuth client
- Open the OAuth clients tab.
- Enter a Client name (e.g., "Payroll sync") and tick its Permissions.
- Click Create OAuth client.
- In the dialog, copy the Client ID and the client secret. The secret is shown once and cannot be shown again.
- Your system requests an access token from the Dawmly API with the client ID and secret. Tokens last one hour; request a new one when it expires. The developer guide shows the request.
Choosing permissions
- Write does not include read. Tick both if the integration needs both. A system that only pushes punches needs Attendance write and nothing else.
- Employees write can end an employee's employment. Terminating an employee through the API also switches off that employee's login, so grant it only to systems you trust with that.
- Payroll read exposes every employee salary and payslip. Grant it only to systems you trust with pay data. Only finalised (approved or paid) payroll runs are visible through the API.
- Keys created before permissions existed can read employees and attendance only, exactly what they could do before.
How to register a webhook
- Switch to the Webhooks tab and click + Add Webhook.
- Enter your endpoint Webhook URL (must use HTTPS in production).
- Optionally type your own signing secret and a description. If you leave the secret blank, Dawmly generates one and shows it once after saving: copy it then, because it cannot be shown again.
- Check the specific event types you want to subscribe to.
- Click Save Webhook.
- Click Send test on the newly created webhook to verify endpoint connectivity and view the delivery record.
Notes and limits
- Available from the Starter plan, for the API, OAuth clients and webhooks alike. If the company drops below Starter, API calls stop, adding, editing or testing a webhook is refused, and webhook events are dropped, not queued. Your keys, clients and webhook subscriptions are kept, and after an upgrade only new events are sent.
- Only organization owners and tenant administrators have access to the Developers screen.
- Keys and clients belong to the company, not to the person who created them: they keep working if that person leaves. The Created by column shows who made each one, so any administrator can revoke it.
- Revoking a key or client, or a plan downgrade, takes effect within about 60 seconds.
- Limits: 60 requests per minute per key or client, and 300 per minute for the whole company.
- There is no sandbox and there are no test keys. Try an integration on a separate test company.
- Every write through the API needs an
Idempotency-Keyheader, so a retried request never creates a duplicate. - Every delivery carries an
X-Dawmly-Signatureheader (HMAC-SHA256 of the body with your secret). The developer guide lists every event and its fields. - Payroll events carry run totals per currency only, never an individual salary.
- Subscriptions created before October 2026 under older event names keep working; editing one ticks the matching events.