API Reference
API Reference

/subscriptions

Subscribe to an event. Required scope: r_candidates or r_employees. Accessible with all token types.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

You can use this endpoint to register your service. The args object can be used to further filter which candidate events you want to receive. The employee-related events do not use it, so it is advised not to include it.

For Recruiting events, if the args object is present, job_shortcode and stage_slug are required. If you want it for all jobs and stages, include an empty string as a parameter for each.
"job_shortcode": ""
"stage_slug": ""

The target URLs should be unique. If a target URL is already registered, the service will respond with 409 - Conflict.

Body Params
string
required

The URL of the endpoint to push notifications at

string
required

One of candidate_created, candidate_moved, employee_created, employee_updated, employee_published, onboarding_completed, timeoff_updated

args
object

Arguments for the subscription

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json