v1
latestOpenAPI 3.0.02026-07-24161168406.5 KBWebhook Configurations
Configuring webhooks
Configure a webhook.
post/webhooks
Request body
action'application.created' | 'application.completed' | 'application.moved' | 'application.assigned' | 'candidate.hired' | 'job.changed' | 'job.new-recommendation' | 'job.published' | 'job.status-changed' | 'pre-employee.moved' | 'pre-employee.admission-concluded' | 'admission.automatic-routing-process' | 'admission.automatic-routing-objection' | 'admission.automatic-routing-confirmation' | 'application.evaluation' | 'job-offer.created' | 'job-offer.status-changed' required
Webhook action to watch
status'active' | 'inactive'
Subscription status (defaults to active).
techOwnerNamestring
Technical responsible for the subscription
techOwnerEmailstring
Email of the technical responsible
postbackUrlstring
Url to be called when webhook is fired
clientHeadersobject
Headers to be included on the request ({ "myCustomHeader": "myExpectedValue "})
Response
A confirmation of successful configuration of the webhook
idstring required
Webhook ID
action'application.created' | 'application.completed' | 'application.moved' | 'application.assigned' | 'candidate.hired' | 'job.changed' | 'job.new-recommendation' | 'job.published' | 'job.status-changed' | 'pre-employee.moved' | 'pre-employee.admission-concluded' | 'admission.automatic-routing-process' | 'admission.automatic-routing-objection' | 'admission.automatic-routing-confirmation' | 'application.evaluation' | 'job-offer.created' | 'job-offer.status-changed' required
Webhook action to watch
status'active' | 'inactive'
Subscription status (defaults to active).
techOwnerNamestring
Technical responsible for the subscription
techOwnerEmailstring
Email of the technical responsible
postbackUrlstring required
Url to be called when webhook is fired
clientHeadersobject
Headers to be included on the request ({ "myCustomHeader": "myExpectedValue "})