Troubleshooting

There are times you may receive errors when accessing our Webhook subscription endpoints or not able to receive our callback notification. This section provide some common ways to narrow down cause of error and resolve some of them.

Custom Authentication Header

Please make sure you have custom authentication header set correctly. Check Webhooks security for more details.

We expect a valid certificate is used for HTTPS connect and we do not accept self-signed certificates.

Publicly Accessible

When using SmartRecruiters webhook, please ensure your service is publicly accessible so that our callback notification can reach your service. There are two quick tests you can perform to check if your service is publicly accessible:

Your service/webhook can reply with HTTP 202 for the following call:

curl -v -H "Accept: application/json" -H "Content-Type: application/json" --data '{"id":"example"}' https://your-host.com/path/to/webhook

Your service/webhook can reply with HTTP 200 and that the response contains “X-Hook-Secret: test” header for the following call:

curl -v -H "Accept: application/json" -H "Content-Type: application/json" -H "X-Hook-Secret: test" --data '{}' https://your-host.com/path/to/webhook

Notification Logs

If you want to check what webhook notifications were sent and what is their status you can do it using GET/subscriptions/{id}/callbacks-log endpoint. You need to specify your subscription identifier for which you want to search for sent notifications. You can also provide additional arguments like callbackStatus to find only successful or failed callbacks or before/after to search only in given time period. In the response you will find the details of the callback requests. You can find there an information about request (url, headers, body) as well as status and timestamp.