Skip to main content
Subscribe to these events via Webhooks to receive notifications when shift data becomes available or changes during a refresh. All webhook payloads include the common fields plus the event-specific fields below.

​
shifts-created

Fires when shift schedule data has been extracted. This occurs for any successful non-refresh Task. Additional fields:
FieldDescription
employment_idThe associated employment record
task_idThe associated Task
objects_countNumber of shifts retrieved
{
  "webhook_id": "f82ab0a92ddd4bb7b6117635159b366a",
  "task_id": "c32fb957ec7246828da56be7516da765",
  "link_id": "9915c50cc047413bb810767f218390f8",
  "product": "employment",
  "data_source": "payroll",
  "tracking_info": null,
  "event_type": "shifts-created",
  "event_created_at": "2022-08-23T17:32:24.812306Z",
  "objects_count": 1,
  "employment_id": "427abebd8590457e8332fdff77fc412f",
  "user_id": "88fef4cea64c40b5ad6727cc9b0b9fdc",
  "template_id": null
}

​
shifts-updated

Fires when the shift count changes during a refresh Task. For example, if a person had 8 shifts and now has 9. Additional fields: Same as shifts-created (employment_id, task_id, objects_count). 
{
  "webhook_id": "f82ab0a92ddd4bb7b6117635159b366a",
  "task_id": "c32fb957ec7246828da56be7516da765",
  "link_id": "9915c50cc047413bb810767f218390f8",
  "product": "employment",
  "data_source": "payroll",
  "tracking_info": null,
  "event_type": "shifts-updated",
  "event_created_at": "2022-08-23T17:32:24.812306Z",
  "objects_count": 1,
  "employment_id": "427abebd8590457e8332fdff77fc412f",
  "user_id": "88fef4cea64c40b5ad6727cc9b0b9fdc",
  "template_id": null
}