Executive Summary

Webhooks in PyjamaHR allow you to receive real-time notifications when key events—such as candidate status changes or new applications—occur in your hiring workflow. This feature is essential for integrating PyjamaHR with your internal systems or automation tools, enabling seamless data flow and instant updates without manual intervention.

Detailed Overview

What Are Webhooks in PyjamaHR?
Webhooks are automated messages sent from PyjamaHR to your specified endpoint (URL) whenever a specific event happens in your account. For example, you can receive a webhook notification when a new candidate applies for a job or when a candidate’s status changes (e.g., from “Applied” to “Interview Scheduled”).

When and Why to Use Webhooks:
- Automate workflows: Instantly trigger actions in other systems (e.g., update your CRM, notify your team in Slack, or start onboarding in your HRIS).
- Real-time data sync: Keep your internal databases or dashboards up-to-date with the latest candidate information.
- Reduce manual work: Eliminate the need for polling or manual exports.

Integration with Other PyjamaHR Features:
Webhooks are especially powerful when combined with PyjamaHR’s candidate management and job posting features. For example, you can trigger a webhook every time a candidate applies to a job or moves to a new stage in your pipeline.

Business Impact:
- Faster response times to candidate actions
- Improved data accuracy across platforms
- Enhanced automation and productivity

Step-by-Step Guide: Setting Up Webhooks for Status-Change or Event Notifications

Note: Webhook API access is currently available only on PyjamaHR’s Custom Plan. If you’re evaluating PyjamaHR, contact our sales team to discuss enabling this feature.

Prerequisites

Custom Plan: Webhook support is not available on standard plans.
Registered Account: You must have a registered PyjamaHR account.
Endpoint URL: You need a publicly accessible URL to receive webhook payloads.
Technical Contact: Someone on your team should be able to handle incoming HTTP POST requests.

1. Contact PyjamaHR Support to Enable Webhooks

Webhook APIs are not enabled by default.
Email [email protected] or use the in-app chat to request webhook access.
Provide your registered email and details about your intended use (e.g., “I want to receive notifications when a new candidate applies or when a candidate’s status changes.”).

2. Define Your Webhook Events

Specify which events you want to subscribe to. Common examples:
- New candidate applied
- Candidate status changed (e.g., from “Applied” to “Interview Scheduled”)
Clearly communicate your requirements to the support team for correct configuration.

3. Provide Your Webhook Endpoint

Share the URL where you want to receive webhook notifications.
Ensure your endpoint is ready to accept HTTP POST requests and can process JSON payloads.

4. PyjamaHR Configures Your Webhook

The PyjamaHR technical team will set up the webhook on your account.
You will receive confirmation once the webhook is active.

5. Test Your Webhook Integration

Perform a test event (e.g., apply to a job or change a candidate’s status).
Verify that your endpoint receives the expected payload.
Adjust your endpoint logic as needed to handle the data.

Screenshot Callouts:
- “Webhook Setup” confirmation email from PyjamaHR
- Example webhook payload in your endpoint’s logs

Advanced Usage & Best Practices

Security: Validate incoming requests using a secret token or IP allowlisting to ensure only PyjamaHR can send data to your endpoint.
Retry Logic: Implement logic to handle duplicate or retried webhook events.
Data Handling: Store event IDs to prevent processing the same event multiple times.
Integration: Use webhooks to trigger workflows in tools like Slack, Microsoft Teams, or your internal HRIS (note: direct Zapier integration is not supported as of now).
Documentation: Maintain clear documentation of your webhook endpoints and expected payloads for your technical team.

Do’s:
- Do specify exactly which events you need.
- Do test your endpoint with sample payloads before going live.

Don’ts:
- Don’t expose unsecured endpoints.
- Don’t assume all events are enabled by default—request only what you need.

Troubleshooting & Common Issues

Issue: Not receiving webhook notifications
Solution:
- Confirm your endpoint is publicly accessible and not behind a firewall.
- Check with PyjamaHR support that your webhook is active and correctly configured.

Issue: Receiving duplicate events
Solution:
- Implement idempotency in your endpoint (process each event ID only once).

Issue: Webhook payload format is unclear
Solution:
- Request a sample payload from PyjamaHR support for your specific event type.

What if I need to change my webhook URL?
- Contact PyjamaHR support with your new endpoint details.

When to contact support:
- If you need to add or remove event types
- If you experience persistent delivery failures
- If you require payload customization

Comprehensive FAQ

Do you support Zapier integration?
No, direct Zapier integration is not currently supported.
Is webhook access available on all plans?
No, webhook APIs are available only on the Custom Plan.
Can I get a list of all supported webhook events?
Contact support for the current list of available events (e.g., new candidate applied, candidate status changed).
How do I test my webhook integration?
Trigger the relevant event in PyjamaHR (e.g., apply to a job) and check your endpoint for the POST request.
What data is included in the webhook payload?
Request a sample payload from support; typically includes candidate details, job ID, and event type.
Can I receive webhooks for multiple events?
Yes, specify all required events when requesting setup.
How do I secure my webhook endpoint?
Use secret tokens, HTTPS, and IP allowlisting.
What if my endpoint is temporarily unavailable?
PyjamaHR may retry delivery; confirm retry policy with support.
Can I change or remove my webhook configuration?
Yes, contact support to update or remove your webhook.
Is there a UI for managing webhooks?
Currently, webhook setup and changes are managed via support, not through the self-service UI.
Can I get candidate lists or details via API?
Webhooks send event notifications; for full candidate data, discuss API access with support.
What if I’m just evaluating PyjamaHR?
Webhook access is available for registered accounts on the Custom Plan; contact sales for a demo or trial.

Candidate Management: Use webhooks to automate candidate tracking and updates in your internal systems.
Job Posting: Trigger webhooks when new jobs are posted or updated.
Reporting & Analytics: Combine webhook data with your analytics tools for real-time dashboards.

Recommended Next Steps:
- Contact PyjamaHR support to discuss your webhook requirements.
- Review your internal systems’ ability to receive and process webhook payloads.
- Explore additional automation opportunities using PyjamaHR’s event notifications.

Still have questions?
Contact our support team at [email protected] or via in-app chat for personalized assistance with webhook setup and integration.

How to Set Up Webhooks for Status-Change and Event Notifications in PyjamaHR