---
title: "Get Webhook Post Fields"
method: GET
path: "/api/v1/webhooks/post-fields"
tags: ["Webhooks", "Public API"]
---

# Get Webhook Post Fields

`GET /api/v1/webhooks/post-fields`

Returns an object containing the employee fields that can be included in the webhook post body for field-based webhooks. Also includes the related table and page records referenced by those fields. Use the field IDs or aliases from this response in the `postFields` map when creating or updating a field-based webhook.

OAuth Scopes: webhooks

## Response `200`

An object with `fields`, `tables`, and `pages` arrays. `fields` contains the postable employee fields with their IDs, aliases, types, and associated page/table IDs. `tables` and `pages` contain the referenced metadata for those associations.

- WebHookPostFieldResponseObject
  - `fields` WebHookPostFieldDataObject[], required
    - `alias` string, nullable, required — Field identifier used in the API
    - `name` string, required — Field name
    - `type` string, nullable, required — Field type
    - `id` integer, required — Field ID. This may be a standard/custom field ID or a synthetic negative ID for calculated fields.
    - `pageId` integer, required — ID of the page the field belongs to. Calculated fields may use `-1`. Fields without a usable page ID are not available in webhooks.
    - `tableId` integer, nullable, required — ID of the table the field belongs to
  - `pages` WebHookPostFieldPageDataObject[], required
    - `id` integer, required — Page ID
    - `name` string, required — Page Name
  - `tables` WebHookPostFieldTableDataObject[], required
    - `id` integer, required — Table ID
    - `name` string, required — Table Name

## Other responses

- `403` — Permission denied.

---

[API](https://skmtc.net/bamboohr/apis/bamboohr-api.md) · [All operations](https://skmtc.net/bamboohr/apis/bamboohr-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bamboohr/bamboohr-api/revisions/19ebf391a399/schema)