---
title: "Get Webhook"
method: GET
path: "/api/v1/webhooks/{id}"
tags: ["Webhooks", "Public API"]
---

# Get Webhook

`GET /api/v1/webhooks/{id}`

Returns the full configuration of a single webhook owned by the authenticated user, including its name, URL, format, monitored fields and post fields when applicable, events, creation datetime, and last-sent datetime. Returns 403 if the webhook exists but belongs to a different user, and 404 if the webhook does not exist.

OAuth Scopes: webhooks

## Path parameters

- `id` integer, required

## Response `200`

The full configuration of the requested webhook.

- WebHookResponse
  - `id` string — The ID of the webhook.
  - `name` string — The name of the webhook.
  - `created` string — Datetime when the webhook was created (UTC, format: YYYY-MM-DD HH:MM:SS).
  - `lastSent` string, nullable — Datetime when the webhook was last fired (UTC, format: YYYY-MM-DD HH:MM:SS). Null if the webhook has never fired.
  - `monitorFields` string[], nullable — A list of fields being monitored. Null when the webhook is not configured to monitor fields (e.g. event-only webhooks).
  - `postFields` object — A map of field ID or alias to the external name used in the webhook payload.
  - `url` string — The URL the webhook sends data to.
  - `format` 'json' | 'form-encoded' — The payload format used by the webhook.
  - `includeCompanyDomain` boolean — Whether the company domain is added to the webhook request header.
  - `events` WebhookEventType[] — Events that trigger this webhook.
  - `errors` WebhookSubErrorProperty[] — Field-level permission errors associated with the webhook configuration, when present.
    - `error` string
    - `unknownFields` object[]
      - `id` union
        - integer
        - string
      - `name` string
    - `monitorFields` object[]
      - `id` union
        - integer
        - string
      - `name` string
    - `duplicatePostString` string[]
    - `postFields` object[]
      - `id` union
        - integer
        - string
      - `name` string

## Other responses

- `401` — Unauthorized.
- `403` — The webhook exists but belongs to a different user.
- `404` — No webhook exists with the given ID.
- `500` — Internal server error.

---

[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)