Trigger HR Sync

Push the current employee roster from your HR system to JobTicket.

POST /hr-integrations/{id}/sync

cURL

curl --request POST \
  --url "https://v1-api.ticket-plus.app/hr-integrations/7/sync" \
  --header "Authorization: Basic <base64(clientId:clientSecret)>" \
  --header "Content-Type: application/json" \
  --data '{
    "syncId": "sync-2024-05-14-001",
    "employees": [
      {
        "firstName": "Anna",
        "lastName": "Müller",
        "email": "[e-mail]",
        "profileImage": null,
        "dateOfBirth": "1990-04-15",
        "hrId": "emp_HR_001",
        "startDate": "2022-03-01",
        "terminationDate": null,
        "autoSyncEmployee": null,
        "absences": []
      }
    ]
  }'

Submits your complete current employee roster to JobTicket. The API performs a full reconciliation — adding new employees, updating changed records, and offboarding employees no longer in the list.

cURL

curl --request POST \
  --url "https://v1-api.ticket-plus.app/hr-integrations/7/sync" \
  --header "Authorization: Basic <base64(clientId:clientSecret)>" \
  --header "Content-Type: application/json" \
  --data '{
    "syncId": "sync-2024-05-14-001",
    "employees": [
      {
        "firstName": "Anna",
        "lastName": "Müller",
        "email": "[e-mail]",
        "profileImage": null,
        "dateOfBirth": "1990-04-15",
        "hrId": "emp_HR_001",
        "startDate": "2022-03-01",
        "terminationDate": null,
        "autoSyncEmployee": null,
        "absences": []
      }
    ]
  }'

http 204 No Content (empty body)

This is a full-roster replace operation. Any employee omitted from the employees array will be offboarded in JobTicket. Always include every currently active employee in the payload.

Path Parameters

id · number · required

The unique numeric ID of the HR integration to sync against. Obtain this from List HR Integrations.

Body

syncId · string · required

A unique identifier for this sync operation. Used for idempotency and audit logging. Use a UUID or timestamp-based string. Re-submitting with the same syncId is safe — duplicate submissions will be deduplicated.

employees · object[] · required

The complete current employee roster from your HR system. Must contain at least one employee. Employees absent from this list will be offboarded in JobTicket.

Show employee object

firstName · string · required

Employee’s first name.

lastName · string · required

Employee’s last name.

email · string · required

Employee’s work email address. Used to match against existing JobTicket accounts.

profileImage · string | null · required

URL to the employee’s profile photo. Pass null if not available.

dateOfBirth · string · required

Date of birth in YYYY-MM-DD format.

hrId · string · required

The employee’s unique identifier in your HR system. Used to match records across syncs — must be stable and never reused for a different person.

startDate · string · required

Employment start date in YYYY-MM-DD format.

terminationDate · string | null · required

Termination date in YYYY-MM-DD format. Set this when the employee is leaving the company or has been deleted from your HR system. Pass null if the employee is still active.

autoSyncEmployee · boolean | null · required

Controls whether this employee is automatically included in future scheduled syncs. This field is only relevant if you have configured a custom field in your HR system to manage employee subscription eligibility — in that case, pass true or false based on the custom field value. If you are not using a custom field to control subscriptions, this field is not applicable and should be set to null.

absences · object[] · required

Current absences for this employee. Pass an empty array [] if there are none.

Show absence object

absenceTypeId · string · required

The unique ID of the absence type as it exists in your HR system. This is an opaque identifier — pass the raw ID your HR system assigns to the absence type, without mapping or transforming it.

absenceId · string · required

Unique identifier for this specific absence record in your HR system.

fromDate · string · required

Absence start date in YYYY-MM-DD format.

toDate · string · required

Absence end date in YYYY-MM-DD format.

active · boolean · required

Set to true if the absence has been approved. Set to false if the absence has been rejected or deleted from your HR system.

Response

(empty body) · null

204 No Content — The sync has been accepted and will process in the background. The response body is empty.

Authorizations

Authorization · string · header · required

HTTP Basic Auth using your API key credentials. Use the username and password issued from the Developer Portal. Encode them as Base64(username:password) and pass in the Authorization: Basic <token> header.

Path Parameters

id · number · required

The unique numeric ID of the HR integration to sync against.

Body

application/json

syncId · string · required

A unique identifier for this sync operation. Used for idempotency and audit logging. Use a UUID or timestamp-based string.

employees · object[] · required

The complete current employee roster from your HR system. Must contain at least one employee. Employees absent from this list will be offboarded in JobTicket.

Minimum array length: 1

Show child attributes

Response

204 - application/json

Sync accepted and will process in the background. The response body is empty.

Empty body on success.