Setting up and managing webhooks

What is a webhook?

A webhook allows your CareerPlug account to send real-time data to other applications based on specific events. Think of it as an automatic notification system that triggers workflows in other systems when certain actions happen in CareerPlug.

What are the benefits of a webhook?

You may want to use a webhook for a variety of reasons, but primarily it allows you to send real-time data from CareerPlug to another system.

Here are some use cases for when you might want to use a webhook:

Real-Time Notifications: Send immediate updates to your CRM when new applicants apply.
Automated Productivity Workflows: Use tools like Trello, Asana, or Monday.com to trigger task creation when applicants progress through the hiring process.
Custom Integrations: Connect applicant information to custom background check, scheduling, or reporting systems.

Who can use a webhook?

Anyone with access to CareerPlug's PartnerHub can use webhooks, whether you're a small business owner or have a technical team to assist you. PartnerHub makes setting up webhooks simple!

Where do I manage my CareerPlug webhook?

You will manage your webhook from CareerPlug's PartnerHub.

If you have an existing webhook, you can see its Label (name), (callback) URL, Partnership, Last Status, Last Run Date, and whether it's Active.

The Last Status field displays "200" if your webhook is working or "500" if your webhook encounters an error and needs troubleshooting. The Last Run Date refers to the last time your webhook was triggered, sending information back to your callback URL.

To edit your existing webhook, click the three dots icon under Actions and select Edit from the drop-down menu.

Note: You can also Test, Pause, or Delete your webhook from the Actions menu.

How do I set up my CareerPlug webhook?

1. Click the plus sign icon (+).

2. Enter a name for your webhook in the Label field.

3. Enter your callback URL in the associated field.

A callback URL is the destination where you want your data to end up. If you need to obtain a URL from another application, ask them to provide a callback URL.

4. Select your Partnership from the drop-down menu.

Note: There will only ever be one option available for your designated Partnership, which cannot be edited.

5. Turn on the Is Active? toggle if you'd like to activate your webhook immediately.

6. Turn on the Support basic auth? toggle if the destination requires authentication (optional).

With the Support basic auth? toggle enabled, you'll be prompted to enter your username and password for the destination to which you're connecting your webhook. Once connected, your webhook will send your login credentials with each request.

7. Select any Events that you want to trigger the webhook. You can select as many as you'd like.

8. Click the Save button.

What events trigger a webhook?

You can choose up to 6 events to trigger a CareerPlug webook.

App Created: This is when any new applicant has applied and shows up in your CareerPlug account.
App Updated: This event occurs when the application profile is updated.
Interview Created: When a user schedules an Interview with an applicant.
App Hired: When a user clicks “Hire” in their CareerPlug account.
App Unhired: When a user clicks “Undo Hire” in their CareerPlug account.
App Hiring Step Changed: This occurs when the user has moved an applicant into another step of the hiring process. The change can be triggered by moving forward or backward in the hiring process.

Frequently asked questions (FAQ)

Q: What is a Webhook Signing Key?

A: The Webhook Signing Key ensures secure communication by verifying that the data originates from CareerPlug. For better security, we recommend this option over basic authorization. Turning this on generates a secure, randomized key that applies to all webhooks associated with your CareerPlug Partnership and is sent with each webhook delivery.

Q: Is there documentation around the Webhook Signing Key?

A: Yes. The documentation for Webhook Signing Keys is in Webhook Security, which is to the right of the Webhook Signing Key.

Q: What does a webhook payload look like?

{ "data": { "id": 32754, "hiring_status": "new_app", "hired_at": "2025-03-12T20:19:24.346-05:00", "source_name": "Test Source", "started_at": "2025-03-14T20:19:24.346-05:00", "interview": { "id": 10404, "status": "scheduled", "start_datetime": "2025-03-19T20:19:24.346-05:00", "end_datetime": "2025-03-19T21:19:24.346-05:00", "timezone": "Central Time (US & Canada)" }, "applicant": { "id": 72667, "address": "1738 Schmidt Mountain", "city": "South Majorie", "country": "US", "email": "mickey.senger@kuvalis.name", "employment_type": "full_time", "firstname": "Wilford", "lastname": "Weimann", "pay_rate": null, "pay_type": null, "phone": "555-691-9831", "recent_title": "Investor Legal Coordinator", "recent_employer": "O'Connell, Cummerata and Stracke", "state": "YT", "zip": "P6R0V7" }, "job": { "id": 1058, "name": "Customer Community-Services Associate", "minimum_compensation": "78.38", "pay_type": "per hour", "employment_type": "full_time", "code": "Z6RQD3" }, "account": { "id": 54280, "name": "Boyer Inc", "account_type_id": 761 }, "hiring_step": { "id": 36570, "name": "Interview" }, "location": { "id": 87907, "city": "North Benitoport", "district_name": "Royal Estates", "name": "Seymour Coves", "number": "TGCEJ", "region_name": "Southwest", "state": "PE", "zip_code": "C0L1S5" } }, "event_name": "app_created", "created_at": "03/13/2025 01:19AM", "signature": { "timestamp": "1741828764", "token": "adf78e87181d7905b2911b230c20ad9daa3ca881e3876a66bcab793c0dcaa6c6", "signature": "34b221a51bab00d8016be8a9937787ab888105b447afd4a29f6ca3e523a9b55a" } }

Need help with your webhook?

If you encounter issues, contact our Technical Account Manager at TechAM@careerplug.com.