labor shift created

EVENT

labor.shift.created

Published when a worker starts a Shift.

Permissions:TIMECARDS_READ

Link to section

Event payload

Example code

Link to section

merchant_id

string

The ID of the target merchant associated with the event.

Link to section

type

string

The type of event this represents. For this event, the value is shift.

Link to section

event_id

string

A unique ID for the event.

Link to section

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

Link to section

data

Data associated with the event.

Link to section

Examples

Response JSON

{
  "merchant_id": "6SSW7HV8K2ST5",
  "type": "labor.shift.created",
  "event_id": "aeaaa5f6-c4fd-4e93-b688-71b50706266f",
  "created_at": "2019-10-29T17:26:16.808603647Z",
  "data": {
    "type": "shift",
    "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"
          },
          "job_id": "FzbJAtt9qEWncK1BWgVCxQ6M",
          "tip_eligible": true
        },
        "declared_cash_tip_money": {
          "amount": 500,
          "currency": "USD"
        },
        "status": "OPEN",
        "version": 1,
        "created_at": "2019-11-06T19:14:55Z",
        "updated_at": "2019-11-06T19:14:55Z"
      }
    }
  }
}