Job webhook
The Job webhook integration lets Nextal push job data to any external HTTP endpoint whenever a job event occurs. This is how teams keep an external website, an ATS integration layer, or a data warehouse in sync with Nextal job postings — without polling. You control the target URL, how requests are authenticated, and optionally how the payload is structured.
What it does
- Sends an HTTP request to your endpoint when job data changes.
- Supports five authentication modes: None, Basic Auth, Bearer Token, JWT, and API Key.
- By default, sends the complete Nextal job object. Optionally, enables custom field mapping to reshape the payload to match your endpoint’s expected schema.
- Accepts a Response ID Path so Nextal can extract and store the external system’s identifier from the response.
Prerequisites
- An HTTP endpoint (HTTPS strongly recommended) that can receive POST requests.
- Authentication credentials for that endpoint, depending on which auth mode it requires.
How to activate
- Go to Administration → Integrations and find the Job Webhook Sync card.
- Click Edit to open the configuration panel.
- Check Enable Job Webhook Sync.
- Enter the Webhook URL — the full HTTPS URL of your endpoint.
- Optionally, enter a Response ID Path — a JSON path expression (e.g.
$.data.id) pointing to the unique identifier in the endpoint’s response. Nextal stores this value to correlate future updates. - Choose an Authentication Type and fill in the corresponding fields (see Settings below).
- If your endpoint requires a custom payload structure, check Use Custom Field Mapping and map the standard job fields to the JSON paths your endpoint expects. You can also add Custom Field entries to inject fixed values at arbitrary paths.
- Click Save.
Settings
Core settings
| Setting | Description |
|---|---|
| Enable Job Webhook Sync | Master toggle for the integration. |
| Webhook URL | The HTTPS endpoint that receives job data. Required. |
| Response ID Path | A JSON path expression to extract the external ID from the response body (e.g. $.data.id). Optional. |
Authentication
| Authentication Type | Fields required |
|---|---|
| None | No credentials. |
| Basic Auth | Username and Password. |
| Bearer Token | Token value. |
| JWT | Algorithm (HS256 / HS384 / HS512 / RS256 / RS384 / RS512), JWT Secret, and optionally a JSON payload to include in the token claims. |
| API Key | Key Name (e.g. X-API-Key), Key Value, and Location (Header or Query Parameter). |
Field mapping (optional)
When Use Custom Field Mapping is enabled, you can map standard Nextal job fields to the JSON paths your endpoint expects:
| Nextal field | Example target path |
|---|---|
| id | $.job.id |
| title | $.job.title |
| shortDescription | $.job.description |
| fullDescription | $.job.fullDescription |
| location | $.job.location |
| minSalary | $.job.salary.min |
| maxSalary | $.job.salary.max |
| contractType | $.job.contractType |
| language | $.job.language |
| jobPublicURL | $.job.jobPublicURL |
| jobApplicationPublicURL | $.job.jobApplicationPublicURL |
| featurePhoto | $.job.featurePhoto |
You can also add Custom Fields to inject static values at any JSON path in the payload (for example, setting $.source to nextal).
Tips
- Use HTTPS. Job payloads may contain salary data and other sensitive fields — always use a secured endpoint.
- Start without custom field mapping. The default payload is a complete job object that most integrations can work with directly. Enable custom mapping only if your endpoint has a rigid schema requirement.
- Use the Response ID Path when your endpoint assigns its own IDs. This lets Nextal send the correct identifier on subsequent updates (e.g.
PUT /jobs/{external-id}) rather than always creating new records. - Test your endpoint independently first. Use a tool like Postman or a request-bin service to confirm your endpoint accepts the payload format before connecting it here.
- JWT tokens are generated per request. Each outbound webhook call generates a fresh JWT signed with the configured secret and algorithm.