Clock Events

Authentication: All endpoints require an Authorization: Bearer <access token> header.

Most endpoints require an X-Company-ID: <company_id> header to scope requests to a specific company. This is the recommended header for most API operations.

Some endpoints require an X-Location-ID: <location_id> header when the query doesn't accept a locationId parameter.

See Authentication for details on how to obtain and use these headers.

Add Clock Event

Record a clock event for an employee (clock in, clock out, break in, break out).

Required Fields:

Field Description
deviceId Identifier for the clocking device (e.g., "SANDBOX_CLOCKING_DEVICE")
timeLocal Local time of the clock event (format: "YYYY-MM-DD HH:mm:ss")
timeServer Server time of the clock event (format: "YYYY-MM-DD HH:mm:ss")
status Clock event status code (see status codes below)
employeeId ID of the employee clocking in/out

Clock Event Status Codes:

Status Description
100 Clock In
110 Break Out
120 Break In
130 Clock Out

Implementation Notes:

  • Both timeLocal and timeServer use the format: YYYY-MM-DD HH:mm:ss
  • Times should be in 24-hour format
  • timeLocal represents the time in the employee's local timezone
  • timeServer represents the server time (typically UTC or system timezone)
  • Create your own device identifier string for your integration
  • Use a consistent identifier across all clock events from the same device

GraphQL Mutation

mutation AddClockEvent($input: AddClockEventInput!) {
  addClockEvent(input: $input) {
    id
  }
}

Example Variables - Clock In

{
  "input": {
    "deviceId": "SANDBOX_CLOCKING_DEVICE",
    "timeLocal": "2024-03-25 08:31:00",
    "timeServer": "2024-03-25 08:31:00",
    "status": 100,
    "employeeId": "72909"
  }
}

Example Response

{
  "data": {
    "addClockEvent": {
      "id": "3088"
    }
  }
}