Webhooks

How do I create a webhook?

Purpose: This guide will teach you how to create a webhook in BambooHR that allows you to monitor changes to specific fields.

Webhooks allow you to monitor changes to a specific list of fields. You can choose which fields you want to monitor and the frequency of monitoring. You will also be able to add other fields for monitoring, such as an employee's name. BambooHR will post the information to a URL you must provide, and you will need help from a developer at your company to set up a webhook.

You can learn more about webhooks here.

Add a webhook

Webhooks

To create a webhook, navigate to Settings > Account > Webhooks and then click +Add Webhook.

If you do not see the Webhooks section in Settings, please contact a support hero to have this feature enabled.

Add Webhook
  1. Webhook Name: Name the webhook.
  2. What fields do you want to monitor?: Select which fields you would like to monitor with this webhook.* Only the fields in this list are available for monitoring with webhooks.
  3. What fields do you want to post?: Select which fields you would like to post along with your webhook. For example, you may want to post an employee's employee # or their name with the fields you are monitoring to make it easier for you to keep track of the changes.
  4. What format should the data be in?: Select which format you would like the data to be in.
  5. Post to URL: This step requires a developer on your end to create a URL for posting the data changes.
  6. Private Signature Key: Click +Generate Key to create a private signature key you can save and use to verify that the webhook came from BambooHR. When using a private signature key, the webhook is secured using SHA-256 HMAC.
    • NOTE: You can only copy this key at the point it is generated. Once you save the webhook, it is no longer available to view, and if lost, you will need to regenerate it. Click COPY KEY for safekeeping.
  7. When should the data be sent?: Determine how often you would like to have the data sent.

After setting up the webhook, click Save to create the webhook.

*A change that occurs to one of the monitored fields (not any additional fields you have selected) will prompt the webhook to notify you of the change.