---
title: "Shift Claimed"
method: POST
path: "v1.shift.claimed"
---

# Shift Claimed

`POST v1.shift.claimed` (webhook)

## Payload

- object
  - `id` string, required
  - `type` 'v1.shift.claimed', required
  - `timestamp` string, required
  - `traceId` string, required
  - `actor` object, required
    - `id` string, required
    - `type` string, required
    - `name` string, required
  - `data` object, required
    - `id` string, uuid, required
    - `createdAt` string, required
    - `version` number: Version number for optimistic locking. Include this when updating to detect conflicts.
    - `provider` string, uuid, nullable, required: The provider of the shift. If null, the shift is an open shift.
    - `providerName` string, nullable: The display name of the provider. Only populated when the request opts in via includeDisplayNames.
    - `startDate` string, required
    - `endDate` string, required
    - `segments` ShiftSegment[], required: The segments that make up a shift, ordered by startDate.
      - `id` string, uuid, required
      - `importedId` string, nullable, required: If a segment was created in an external system, this is the ID of the segment in that system.
      - `createdAt` string, required
      - `role` string, uuid, nullable, required: The role of the shift. Can be null if the shift is pulled from an external system.
      - `roleName` string, nullable: The display name of the segment's role. Only populated when the request opts in via includeDisplayNames.
      - `roleColor` string, nullable: The hex color of the segment's role. Only populated when the request opts in via includeDisplayNames.
      - `roleImportedId` string: *DEPRECATED* The ID of the role in the external system. Once all roles are migrated to the system, this field will be removed.
      - `additionalInfo` unknown
      - `isBreak` boolean, required: Used to denote whether or not the provider will be on break during this segment.
      - `isOnCall` boolean, required
      - `type` 'working' | 'paid_break' | 'unpaid_break' | 'on_call', required: The type of the segment.
      - `startDate` string, required: The timestamp of when the shift starts.
      - `endDate` string, required: The timestamp of when the shift ends.
      - `skillRequirement` union
        - SkillRequirementCondition
          - `type` 'equal', required
          - `skill` string, required
          - `value` string, required
        - SkillRequirementGroup
          - `type` 'and' | 'or', required
          - `entries` union[], required
            - union
              - …
      - `labels` string[], required: The label IDs associated with this shift segment.
    - `payCodes` ShiftPayCode[]
      - `payCodeId` string, uuid, required: The pay code ID associated with this shift.
      - `value` number: Only present for variable pay codes. The value of the pay code for this shift.
    - `team` string, uuid, nullable, required: The team that the shift is associated with.
    - `note` string, nullable, required: A note about the shift. Visible to providers.
    - `isCallout` boolean, required: Whether the shift is marked as a callout. Callout shifts are hidden from reads unless an endpoint explicitly includes them.
    - `workRuleOverride` string, uuid, nullable, required
    - `claimedBy` string, uuid, required: The provider who claimed the open shift.

## Acknowledgement `200`

Webhook received successfully

---

[API](https://skmtc.dev/untetherlabs/apis/untether-labs-api.md) - [All operations](https://skmtc.dev/untetherlabs/apis/untether-labs-api/llms.txt) - [OpenAPI document](https://skmtc.dev/untetherlabs/apis/untether-labs-api/revisions/143223935df3?raw)