Skip to main content

Webhooks Guide

Setting up and using webhooks to export candidate data

Shaun Corness avatar
Written by Shaun Corness
Updated over a month ago

Getting Started

Webhooks allow you to automatically send candidate data from talentATS to external systems. When you export candidates via webhook, their information is sent to a URL you specify, allowing integration with other tools and services.

What Are Webhooks?

A webhook is:

  • A URL endpoint in an external system

  • A destination for data exports

  • An automated connection between talentATS and your other tools

  • A way to keep systems in sync without manual work

When you export candidates to a webhook, talentATS sends their data as a request to that URL.

Accessing Webhooks

Managing Organisation Webhooks

To set up webhooks for your organisation:

  1. Go to Settings > Access Management > Webhooks

  2. You'll see your organisation's webhooks

  3. Add, view, or delete webhooks as needed

Permission required: Organisation Admin role

Setting Up Webhooks

Step 1: Have Your Webhook URL Ready

Before adding a webhook, you need:

  • A valid webhook URL from your external system

  • The URL must be publicly accessible

  • The URL must be active and able to receive requests

  • The format should be: https://yourdomain.com/webhook or similar

Step 2: Add a Webhook

To add a new webhook to your organisation:

  1. Go to Settings > Access Management > Webhooks

  2. Click Create Webhook

  3. Enter the webhook URL

  4. Verify the URL is correct and accessible

  5. Click Create Hook

Step 3: Test the Webhook

Before using in production:

  1. Export a small test batch of candidates

  2. Confirm the data arrives at your webhook URL

  3. Verify the data format is correct

  4. Test your system's processing of the data

If the export fails:

  • Verify the URL is correct

  • Check the URL is publicly accessible

  • Ensure your external system is running

  • Contact support if issues persist

Exporting to Webhooks

During Vacancy Candidate Management

When exporting candidates from a vacancy:

  1. Open the vacancy and find candidates

  2. Select candidates to export using checkboxes

  3. Click Export action

  4. Choose Export to Webhook

  5. Select your webhook from the list

  6. Confirm the export

  7. Data is sent to the webhook URL

What Gets Exported

When you export candidates to a webhook, the following data is typically included:

  • Candidate name and contact information

  • Application details

  • Candidate qualifications and experience

  • Current stage in your pipeline

  • Any ratings or assessments

  • Application timestamp

Export Format

Data is sent as:

  • Structured JSON format

  • Single request per export batch

  • All selected candidates in one request

Your external system should be configured to parse and process this format.

Managing Webhooks

Deleting Webhooks

To remove a webhook:

  1. Find the webhook in your list

  2. Click Delete or the delete icon

  3. Confirm the deletion

  4. The webhook is removed immediately

After deletion:

  • The webhook URL can no longer be used

  • You cannot export to this webhook anymore

  • If you need it again, create a new webhook

Updating Webhooks

Currently, webhooks cannot be edited after creation. If you need to change a webhook URL:

  1. Delete the existing webhook

  2. Create a new webhook with the correct URL

  3. Update any references to the old URL

Common Webhooks Scenarios

Zapier Integration

Connect to hundreds of apps via Zapier:

  1. Log in to Zapier and create a new Zap

  2. Choose "Webhooks by Zapier" as the trigger

  3. Get your Zapier webhook URL

  4. Add the Zapier webhook URL in talentATS

  5. Export candidates to Zapier

  6. Configure Zapier to send data to your desired apps (Slack, Google Sheets, email, etc.)

Integration with External HR Systems

Send candidate data to another ATS or recruitment tool:

  1. Get the webhook URL from your external system

  2. Add it as a webhook in talentATS

  3. Export candidates to sync them automatically

CRM Integration

Send candidates to your CRM system:

  1. Configure a webhook in your CRM

  2. Add the CRM webhook URL in talentATS

  3. Export shortlisted candidates to your CRM

Data Warehouse or Analytics

Send candidate data for reporting and analysis:

  1. Set up a webhook endpoint in your data system

  2. Configure it in talentATS

  3. Export candidates to feed your analytics

Troubleshooting

I can't add a webhook:

  • Verify you have Organisation Admin role

  • Ensure the URL is valid format

  • Check the URL is publicly accessible

  • Try again with a different URL if issues persist

  • Contact support if problems continue

Export to webhook failed:

  • Verify the webhook URL is correct

  • Check the URL is still active and accessible

  • Ensure your external system is running

  • Confirm the system is accepting requests

  • Check for network or firewall issues

  • Contact your external system's support

I can't delete a webhook:

  • Verify you have Organisation Admin role

  • Ensure no exports are currently in progress

  • Try refreshing the page

  • Contact support if the issue persists

Exported data is not arriving:

  • Confirm the webhook URL is correct

  • Verify your external system received the request

  • Check your system logs for incoming requests

  • Ensure the data format matches expectations

  • Ask your external system's support team

I need to update a webhook URL:

  • Currently, webhooks cannot be edited

  • Delete the existing webhook

  • Create a new webhook with the correct URL

  • Update any processes that reference the old webhook

How do I know if an export succeeded:

  • Check your external system for incoming data

  • Look for new records created from the export

  • Ask support if you need confirmation of export attempts

  • Review any logs or notifications from your system

Security Considerations

Data Protection

  • Use HTTPS – Always use secure URLs

  • Validate endpoints – Ensure URLs are correct

  • Test carefully – Verify before using in production

  • Monitor activity – Watch for unusual exports

Access Control

  • Restrict to Admins – Only Organisation Admins should manage webhooks

  • Document URLs – Keep records of what's connected

  • Review regularly – Check webhooks are still needed

Next Steps

  • Set up your first webhook

  • Test with a small candidate export

  • Integrate with your external systems

  • Document your webhook configuration

  • Contact support if you need assistance

Need more help? Click "Need Help?" in your profile dropdown or contact our support team for assistance.

Did this answer your question?