API Reference

/subscriptions

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

Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…

You can use this endpoint to register your service. The arguments object can be used to further filter which events you want to receive.

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

object

Arguments for the subscription

Responses

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