Note: Before enabling this webhook, check out our webhook Developer Resources, and in particular, the candidate hired webhook to see an example JSON schema. When you create your webhook, it will contain all of the same object keys for Greenhouse's standard fields. The only keys that will be unique to your Greenhouse Recruiting instance are those in the custom_fields arrays shown for each example object.
Create a candidate hired webhook
To create a candidate hired webhook, click the Configure icon on your navigation bar, then select Dev Center on the left.
Click Web Hooks > Web Hooks.
Create a new webhook using the following details:
- Name: We recommend something easily identifiable to an end user, such as [HRIS name] candidate export.
- When: Candidate has been hired
- Endpoint URL: The HRIS URL that will receive and transform the candidate data.
- Secret key: This can be set to any value. Greenhouse Recruiting combines the value set with the body of the webhook and uses the SHA256 algorithm to generate a signature header to include in the payload. When the webhook listener receives the webhook, the integration should compute the HMAC digest using the secret key and the body of the payload, then verify that Greenhouse Recruiting sent the webhook by comparing the signature header that was previously generated with the signature header included in the webhook.
- Error recipient email: The address that receives an email notification if the webhook fails. There is no in-app notification if the webhook fails after the initial ping.
If your HRIS endpoint requires additional Basic or OAuth authentication, click Advanced settings.
You can configure additional webhook headers as required, or configure the number of retry attempts Greenhouse Recruiting should make if the webhook fails. You can learn more about our webhook retry policy in our Developer Resources.
Click Create Web hook to complete the setup.
Greenhouse Recruiting will ping your endpoint URL. If the ping is successful, the webhook will be created. If the ping is unsuccessful, your configuration will be saved, but the webhook will be deactivated.
To edit an existing webhook, check out Edit or deactivate a webhook.