DocumentationAPI Reference
API Reference

Update Webhook

put
https://{companyDomain}.bamboohr.com/api/v1/webhooks/

Performs a full replacement update of a webhook — all request body fields overwrite existing values, so omitted optional fields revert to defaults. The monitorFields array must be non-empty when the webhook's events include employee.updated or employee_with_fields.updated (the default event set includes employee_with_fields.updated). The private key is not regenerated on update. Use List Webhooks to discover webhook IDs.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

The webhook ID to update.

Body Params
string
required

The name of the webhook.

monitorFields
array of strings

A list of fields to monitor. At least one field is required to be monitored if events is empty or contains employee_with_fields.updated or employee.updated.

monitorFields
postFields
object

An object map of field ID or alias to the external name used in the webhook payload (e.g. {"firstName": "First Name"}). Omit or send an empty object to include no extra fields.

string
required

The url the webhook should send data to (must begin with https://).

string
enum
required

The payload format the webhook uses. Required.

Allowed:
boolean

If set to true, the company domain will be added to the webhook request header.

events
array of objects

Events that trigger this webhook. Defaults to ['employee_with_fields.updated', 'employee_with_fields.deleted', 'employee_with_fields.created'] if not specified. Cannot mix employee_with_fields events with employee events.

events
Responses

401

Unauthorized.

Updated 3 days ago

Language
Credentials
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 days ago