v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB

Webhooks

Public API

List Monitor Fields

Returns the list of employee fields that can be monitored by a webhook. Monitor fields are only applicable to webhooks that use update events (employee.updated or employee_with_fields.updated). Use the field IDs or aliases from this response in the monitorFields array when creating or updating a webhook via Create Webhook or Update Webhook.

OAuth Scopes: webhooks

get/api/v1/webhooks/monitor_fields

Response

An object with a fields array containing one entry per monitorable employee field, including the field ID (as a string), human-readable name, and alias (null if no alias is defined).

Example response

{
  "fields": [
    {
      "id": "4175",
      "name": "Accrual Level Start Date",
      "alias": "dateOfBirth"
    }
  ]
}