---
title: "Time Activity User Add Request Event"
method: POST
path: "Time activity user add request"
---

# Time Activity User Add Request Event

`POST Time activity user add request` (webhook)

Receive real-time data updates on time activity events at your specified URL. 

Find more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.

## Acknowledgement `200`

Successful Response

- TimeActivityUserAddRequestWebhookResponse
  - `requestId` string: The request id
  - `company` string, required: The company id
  - `activityType` string, required: The activity type
  - `eventTimestamp` integer, required: The event unix timestamp
  - `evnetTimestamp` integer: DEPRECATED: Use event_timestamp instead
  - `eventType` string: The event type that triggers the webhook
  - `userId` integer, required: The unique identifier of the user
  - `timeClockId` integer: The unique identifier of the time clock
  - `timeActivity` union: The requested time activity. There are no real punches behind it, so the punch sources indicate where the request was submitted from
    - ManualBreakActivityResponse
      - `id` string, required: The unique identifier of the time clock
      - `managerNote` string: The manager note providing additional details
      - `employeeNote` string: The employee note providing additional details
      - `start` TimeActivityTimePointResponse, required
        - `timestamp` integer, required: The timestamp in Unix format (in seconds)
        - `timezone` string, required: The timezone in Tz format (e.g. America/New_York)
        - `locationData` GpsData
          - `address` string: The address associated with the GPS data.
          - `longitude` number: The longitude coordinate.
          - `latitude` number: The latitude coordinate.
        - `geofenceId` string: The ID of the geofence the user was inside when this punch was recorded. None if the punch was outside any configured geofence.
        - `source` PunchSourceResponse
          - `id` string: Unique identifier of the source (for NFC or geofence-based sources)
          - `type` 'autoClockOut' | 'nfc' | 'mobile' | 'pc' | 'kiosk' | 'api' | 'admin', required: An enumeration.
          - `mode` 'dailyLimit' | 'hourLimit' | 'schedulerShiftEnded' | 'geofenceExit' | 'disabledGps' | 'disabledGpsPermission' | 'breakAutoEnd': An enumeration.
          - `name` string: Human-readable name of the source (for NFC or geofence-based sources)
      - `end` TimeActivityTimePointResponse
        - `timestamp` integer, required: The timestamp in Unix format (in seconds)
        - `timezone` string, required: The timezone in Tz format (e.g. America/New_York)
        - `locationData` GpsData
          - `address` string: The address associated with the GPS data.
          - `longitude` number: The longitude coordinate.
          - `latitude` number: The latitude coordinate.
        - `geofenceId` string: The ID of the geofence the user was inside when this punch was recorded. None if the punch was outside any configured geofence.
        - `source` PunchSourceResponse
          - `id` string: Unique identifier of the source (for NFC or geofence-based sources)
          - `type` 'autoClockOut' | 'nfc' | 'mobile' | 'pc' | 'kiosk' | 'api' | 'admin', required: An enumeration.
          - `mode` 'dailyLimit' | 'hourLimit' | 'schedulerShiftEnded' | 'geofenceExit' | 'disabledGps' | 'disabledGpsPermission' | 'breakAutoEnd': An enumeration.
          - `name` string: Human-readable name of the source (for NFC or geofence-based sources)
      - `createdAt` integer: The creation time of the time activity
      - `modifiedAt` integer: The last modification time of the time activity
      - `manualBreakId` string, required: The ID of the manual break
      - `isAutoClockOut` boolean: Indicates whether the user was auto clocked out from the shift
    - TimeOffActivityResponse
      - `id` string, required: The unique identifier of the time clock
      - `managerNote` string: The manager note providing additional details
      - `employeeNote` string: The employee note providing additional details
      - `start` TimeActivityTimePointResponse, required
        - `timestamp` integer, required: The timestamp in Unix format (in seconds)
        - `timezone` string, required: The timezone in Tz format (e.g. America/New_York)
        - `locationData` GpsData
          - `address` string: The address associated with the GPS data.
          - `longitude` number: The longitude coordinate.
          - `latitude` number: The latitude coordinate.
        - `geofenceId` string: The ID of the geofence the user was inside when this punch was recorded. None if the punch was outside any configured geofence.
        - `source` PunchSourceResponse
          - `id` string: Unique identifier of the source (for NFC or geofence-based sources)
          - `type` 'autoClockOut' | 'nfc' | 'mobile' | 'pc' | 'kiosk' | 'api' | 'admin', required: An enumeration.
          - `mode` 'dailyLimit' | 'hourLimit' | 'schedulerShiftEnded' | 'geofenceExit' | 'disabledGps' | 'disabledGpsPermission' | 'breakAutoEnd': An enumeration.
          - `name` string: Human-readable name of the source (for NFC or geofence-based sources)
      - `end` TimeActivityTimePointResponse
        - `timestamp` integer, required: The timestamp in Unix format (in seconds)
        - `timezone` string, required: The timezone in Tz format (e.g. America/New_York)
        - `locationData` GpsData
          - `address` string: The address associated with the GPS data.
          - `longitude` number: The longitude coordinate.
          - `latitude` number: The latitude coordinate.
        - `geofenceId` string: The ID of the geofence the user was inside when this punch was recorded. None if the punch was outside any configured geofence.
        - `source` PunchSourceResponse
          - `id` string: Unique identifier of the source (for NFC or geofence-based sources)
          - `type` 'autoClockOut' | 'nfc' | 'mobile' | 'pc' | 'kiosk' | 'api' | 'admin', required: An enumeration.
          - `mode` 'dailyLimit' | 'hourLimit' | 'schedulerShiftEnded' | 'geofenceExit' | 'disabledGps' | 'disabledGpsPermission' | 'breakAutoEnd': An enumeration.
          - `name` string: Human-readable name of the source (for NFC or geofence-based sources)
      - `createdAt` integer: The creation time of the time activity
      - `modifiedAt` integer: The last modification time of the time activity
      - `policyTypeId` string, required: The ID of the policy type
      - `duration` TimeOffDurationResponse, required
        - `value` number, required: The value of the duration
        - `units` 'hours' | 'days', required: An enumeration.
      - `isAllDay` boolean, required: Indicates whether the time off is all day
    - ShiftActivityResponse
      - `id` string, required: The unique identifier of the time clock
      - `managerNote` string: The manager note providing additional details
      - `employeeNote` string: The employee note providing additional details
      - `start` TimeActivityTimePointResponse, required
        - `timestamp` integer, required: The timestamp in Unix format (in seconds)
        - `timezone` string, required: The timezone in Tz format (e.g. America/New_York)
        - `locationData` GpsData
          - `address` string: The address associated with the GPS data.
          - `longitude` number: The longitude coordinate.
          - `latitude` number: The latitude coordinate.
        - `geofenceId` string: The ID of the geofence the user was inside when this punch was recorded. None if the punch was outside any configured geofence.
        - `source` PunchSourceResponse
          - `id` string: Unique identifier of the source (for NFC or geofence-based sources)
          - `type` 'autoClockOut' | 'nfc' | 'mobile' | 'pc' | 'kiosk' | 'api' | 'admin', required: An enumeration.
          - `mode` 'dailyLimit' | 'hourLimit' | 'schedulerShiftEnded' | 'geofenceExit' | 'disabledGps' | 'disabledGpsPermission' | 'breakAutoEnd': An enumeration.
          - `name` string: Human-readable name of the source (for NFC or geofence-based sources)
      - `end` TimeActivityTimePointResponse
        - `timestamp` integer, required: The timestamp in Unix format (in seconds)
        - `timezone` string, required: The timezone in Tz format (e.g. America/New_York)
        - `locationData` GpsData
          - `address` string: The address associated with the GPS data.
          - `longitude` number: The longitude coordinate.
          - `latitude` number: The latitude coordinate.
        - `geofenceId` string: The ID of the geofence the user was inside when this punch was recorded. None if the punch was outside any configured geofence.
        - `source` PunchSourceResponse
          - `id` string: Unique identifier of the source (for NFC or geofence-based sources)
          - `type` 'autoClockOut' | 'nfc' | 'mobile' | 'pc' | 'kiosk' | 'api' | 'admin', required: An enumeration.
          - `mode` 'dailyLimit' | 'hourLimit' | 'schedulerShiftEnded' | 'geofenceExit' | 'disabledGps' | 'disabledGpsPermission' | 'breakAutoEnd': An enumeration.
          - `name` string: Human-readable name of the source (for NFC or geofence-based sources)
      - `createdAt` integer: The creation time of the time activity
      - `modifiedAt` integer: The last modification time of the time activity
      - `jobId` string: The ID of the job
      - `subJobId` string: The ID of the sub job
      - `schedulerShiftId` string: The unique identifier of the shift from the schedule, if it exists.
      - `shiftAttachments` GeneralActivityShiftAttachmentResponse[]: The shift attachments
        - `shiftAttachmentId` string, required: The ID of the shift attachment
        - `attachment` GeneralActivityShiftAttachmentValueResponse, required
          - `itemId` string: The ID of the dropdown list item
          - `freeText` string: The value of the shift attachment of type free text
          - `number` number: The value of the shift attachment of type number
          - `fileName` string: The name of the file in a shift attachment of type file
          - `fileUrl` string: The URL of the file in a shift attachment of type file
          - `files` ActivityFileResponse[]: The value of the shift attachment of type files
            - `fileName` string, required: The name of the file in a shift attachment of type file
            - `fileUrl` string, required: The URL of the file in a shift attachment of type file
          - `images` string[]: The value of the shift attachment of type images
          - `image` string: The value of the shift attachment of type signature
      - `isAutoClockOut` boolean: Indicates whether the user was auto clocked out from the shift
  - `timeActivityId` string: The time activity id

---

[API](https://skmtc.dev/connecteam/apis/connecteam-api-documentation.md) - [All operations](https://skmtc.dev/connecteam/apis/connecteam-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/connecteam/apis/connecteam-api-documentation/revisions/a01dde7c27fb?raw)