Skip to main content
Dawmly

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

The Developers screen showing API keys management and webhook configuration

How to create an API key

  1. Navigate to the API Keys tab.
  2. Enter a descriptive Key name (e.g., "ERP Integration").
  3. In Permissions, tick what the integration needs. You must choose at least one. Departments, positions and branches follow the Employees permissions.
  4. Click Create API Key.
  5. 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

  1. Open the OAuth clients tab.
  2. Enter a Client name (e.g., "Payroll sync") and tick its Permissions.
  3. Click Create OAuth client.
  4. In the dialog, copy the Client ID and the client secret. The secret is shown once and cannot be shown again.
  5. 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

How to register a webhook

  1. Switch to the Webhooks tab and click + Add Webhook.
  2. Enter your endpoint Webhook URL (must use HTTPS in production).
  3. 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.
  4. Check the specific event types you want to subscribe to.
  5. Click Save Webhook.
  6. Click Send test on the newly created webhook to verify endpoint connectivity and view the delivery record.

Notes and limits

Back to the manual Open the dashboard