---
title: "/subscriptions"
method: POST
path: "/subscriptions"
---

# /subscriptions

`POST /subscriptions`

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

## Request body

- object
  - `target` string, required — The URL of the endpoint to push notifications at
  - `event` string, required — One of candidate_created, candidate_moved, employee_created, employee_updated, employee_published, onboarding_completed, timeoff_updated
  - `args` object — Arguments for the subscription
    - `account_id` string, required — The subdomain of the account, must be included in args
    - `job_shortcode` string, required — Get notifications only for one job. If used, it must be included in args
    - `stage_slug` string, required — Get notifications for specific stages. e.g. 'hired'. If used, it must be included in args

## Response `201`

201

- object
  - `id` integer

## Other responses

- `400` — 400
- `409` — 409

---

[API](https://skmtc.net/workable/apis/root.md) · [All operations](https://skmtc.net/workable/apis/root/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/workable/root/versions/c4116349c08d/schema)
