Weaf HR

Developer Tools

Weaf HR can be driven by other software.

Weaf HR can be driven by other software. A token authenticates the other system, webhooks let it hear about changes as they happen, and the reference documents every endpoint.

One rule governs all of it: a token can only ever see what the person who created it can see. Access is not widened by automating it.

Pages in this chapter
  • API Tokens
  • Webhooks
  • API Reference

API Tokens

Tokens that let other software sign in as your company without a password. A token can only ever see what the person who created it can see, and the token itself is shown once, at creation.

The API Tokens page
The API Tokens page
  • 1 page title
  • 2 records table
Columns
  • NAME
  • TOKEN
  • ACCESS
  • LAST USED
  • EXPIRES
Actions on this page
  • Open API reference
  • OpenAPI spec (JSON)
  • Generate token
Note: The token is shown once, when it is created. If it is lost it cannot be recovered — issue a new one and delete the old.

Webhooks

Addresses the system calls when something happens, so another system can react without polling for changes.

The Webhooks page
The Webhooks page
  • 1 page title
  • 2 primary action
Actions on this page
  • Add endpoint
  • Test
  • Secret

API Reference

The API documentation, with every endpoint listed and a console for trying them. It is public — a developer evaluating the platform can read it without an account.

The API Reference page
The API Reference page
Actions on this page
  • GET /auth/token Check the current token
  • GET /employees List employees
  • GET /employees/{id} Fetch one employee
  • GET /departments List departments
  • GET /designations List designations
  • GET /branches List branches
  • GET /leave-types List leave types
  • GET /payroll-runs List payroll runs
  • GET /payslips List payslips
  • Schemas