Update Webhook

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

Update a webhook, based on webhook ID.

🚧
BETA API
The Webhook API is currently in public beta. We invite developers who are willing to review, test, and provide feedback to use these endpoints and help us stabilize and move them out of beta.
By using these endpoints, developers understand that the Webhook API is subject to change at any time and may cause breaking changes to any integration or application using these endpoints. There may be bugs in how the API performs or inaccuracies in the documentation.
Provide feedback and report bugs here.

Path Params

companyDomain

string

required

The subdomain used to access BambooHR. If you access BambooHR at https://mycompany.bamboohr.com, then the companyDomain is "mycompany"

string

required

{id} is a webhook ID.

Body Params

name

string

required

The name of the webhook.

monitorFields

array of strings

required

A list of fields to monitor.

monitorFields*

postFields

object

required

A list of fields to post to the webhook url. Field ID or alias: external name

url

string

required

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

format

string

The format the webhook should use (json - default, form-encoded).

frequency

object

How often the webhook could fire.

limit

object

To limit how often to potentially fire a webhook, and maximum amount of records to send

includeCompanyDomain

boolean

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

Responses

Language

Credentials


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://api.bamboohr.com/api/gateway.php/companyDomain/v1/webhooks/id \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

🚧BETA API

200Webhook updated successfully.

400Provided JSON is bad, missing required fields, or mulitple access levels.

401The user API key is invalid.

403Permission violations in the fields selected, or the user does not have access to the webhook.

404The webhook to be updated doesn't exist.

500Internal error

🚧
BETA API