POST Timeclock event

Changed on

/timeclocks/event/{timeclock} Permission level: 5

post/timeclocks/event/{timeclock}?access_token=xxxxxxx

Request

  • Base URL
    https://www.humanity.com/api/v2
  • Auth
    API key in query parameter access_token

Query parameters

timeclockinteger required

Time clock ID to which we want to add an event

Request body application/x-www-form-urlencoded

typestring required

Accepted parameter value is of these constant strings: breakin, breakout, notes, location, position, tips

timestampstring date

Sets a custom date and time for this timeclock event. If not set, current time will be used. Should be in yyyy-MM-dd hh:mm:ss (24h) format.

notesstring

String variable holding a note. Used only with type=notes.

locationstring

String containing an ID or a name of a Remote Site. An ID is usually sent. Used only with type=location.

positionstring

String containing an ID or a name of a Position. An ID is usually sent. Used only with type=position.

tipsstring

If a setting "Enable Timeclock Tips" is enabled, employees can enter their tip amounts with this parameter. Used only with type=tips.

Response

200

statusinteger
tokenstring
errorunknown

Example response

{
  "status": 1,
  "data": {
    "event": 100012192
  },
  "token": "e64b900c0dd53053ca974de411849eac8e09fd70"
}

Changes