Shift Event

This endpoint specifies what will be sent to your Contractor Payment Webhook. Zeal POSTs a request containing a pending Shift Object when they have been created, updated, or deleted in the dashboard. You can update and test the webhook URL you want Zeal to hit in the 'API' Page of the Zeal Dashboard.

Request Body


attribute

type

description

test

boolean

Whether the Shift Event was created/updated/deleted in Test Mode

type

string

The operation that was applied to this payment.
create
update
delete
pre-processed
processed

companyID

string

Zeal companyID of Employer

business_name

string

Business name of Employer

Other Shift Object fields


Returns


Doesn't return anything but rather POSTs a request with any changes in the Shift Object to your webhook URL

Raw Content Example


[
  {
    "test": false,
    "type": "update",
    "companyID": "083472985",
    "business_name": "Test Company",
    "shiftID": "123678098765",
    "employeeID": "1234567890",
    "reportingPeriodID": "0987654321",
    "first_name": "test",
    "last_name": "employee",
    "time": "2020-05-17T04:00:00Z",
    "employeeCheckID": "1097456820203947",
    "status": "pending",
    "hourly": {
      "hours": 7,
      "wage": 22
    },
    "reimbursement": {
      "amount": 15
    }
  }
]