/subscriptions

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

post/subscriptions

Request

  • Base URL
    https://subdomain.workable.com/spi/v3
  • URL
    https://subdomain.workable.com/spi/v3/subscriptions
  • Auth
    API key in header Authorization

Request body

targetstring required

The URL of the endpoint to push notifications at

eventstring required

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

Response

201

idinteger

Example response

{
  "id": 42
}

Changes

No recorded changes to this operation across all 2 revisions of this API.