Beta
This feature is in beta and may not be available for all organizations.
Pushes a candidate's data to an HRIS system (e.g. Workday, BambooHR, ADP).
This endpoint triggers the "Add Candidate Data" flow for the specified application
and HRIS system. The candidate must have a name, and any offer associated with
the application must be in an accepted state (for systems that require it) before
pushing.
If the candidate has already been pushed to the same system, the push will be
retried automatically. For SelfServe integrations, integrationPartnerId is
required.
Error codes:
| Code | Description |
|---|---|
candidate_hris_push_blocked_by_offer_status | The candidate's offer is not in a state that permits pushing to this HRIS. |
candidate_hris_push_failed | The HRIS did not accept the push (e.g. a data or validation discrepancy reported by the downstream system, or a precondition it requires). The message includes detail about the failure (typically the error reported by the HRIS). If any of the data was already applied in the external system, verify there before retrying — this endpoint pushes with re-push enabled, so a blind retry can create a duplicate. |
Retries
A
generic_internal_errorresponse does not guarantee the push did not occur — the
candidate mapping and downstream events may already have been created. Do not blindly
retry on this error; check whether the candidate was already pushed first to avoid
duplicate pushes.
Requires the candidatesWrite permission.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||