All Versions

Labor shift created

EVENT labor.shift.created

Published when a worker starts a Shift.

Permissions

TIMECARDS_READ

Event payload

Example code

Name	Description
`merchant_id string`	The ID of the target merchant associated with the event.
`type string`	The type of event this represents.
`event_id string`	A unique ID for the event.
`created_at string`	Read only Timestamp of when the event was created, in RFC 3339 format. Examples for January 25th, 2020 6:25:34pm Pacific Standard Time: UTC: 2020-01-26T02:25:34Z Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00
`data LaborShiftCreatedSquareEventData`	Data associated with the event.

Examples

All Versions

{
  "merchant_id": "6SSW7HV8K2ST5",
  "type": "labor.shift.created",
  "event_id": "aeaaa5f6-c4fd-4e93-b688-71b50706266f",
  "created_at": "2019-10-29T17:26:16.808603647Z",
  "data": {
    "type": "labor",
    "id": "PY4YSMVKXFY9E",
    "object": {
      "shift": {
        "id": "PY4YSMVKXFY9E",
        "employee_id": "AnuhZhsN95oT8f-eCn9D",
        "team_member_id": "AnuhZhsN95oT8f-eCn9D",
        "location_id": "NAQ1FHV6ZJ8YV",
        "timezone": "Etc/UTC",
        "start_at": "2019-01-25T08:11:00Z",
        "end_at": "2019-01-25T18:11:00Z",
        "wage": {
          "title": "Barista",
          "hourly_rate": {
            "amount": 1100,
            "currency": "USD"
          }
        },
        "status": "OPEN",
        "version": 1,
        "created_at": "2019-11-06T19:14:55Z",
        "updated_at": "2019-11-06T19:14:55Z"
      }
    }
  }
}