Disposition Sync API integration guide
Integrate the API to send job application disposition data to Indeed.
By using this API and its documentation and building an integration, you agree to the Additional API Terms and Guidelines.
Integration overview
#To send disposition data to Indeed for both Indeed Apply and non-Indeed Apply jobs, integrate the Disposition Sync API.
Integration steps
#1. Sign a Developer Agreement with Indeed
#Sign a Developer Agreement with Indeed, then submit an integration request through Become an Indeed partner (opens in a new window).
After Indeed approves your account, Indeed enables access and sends you a questionnaire about your integration.
2. Authenticate
#After you become a partner, Indeed creates an app that connects your product to Indeed APIs and services. Get the app's OAuth client ID and secret in Partner Console (opens in a new window).
You don't need separate apps for testing and production. Use the same client ID in both the Review phase and the Production phase.
To authenticate Disposition Sync API calls, exchange the client ID and secret for an access token. The token expires after one hour.
3. Send ATS disposition data to Indeed
#Send disposition data for every Indeed-sourced job application in your ATS, following these guidelines:
- When the ATS receives the application, send at least one disposition with
dispositionStatusset toNEW. - Map each disposition to the closest Indeed standard disposition status.
- When an application changes, send the update right away, or at least once a day.
- In each request, sort dispositions by status-change timestamp, oldest first.
- Duplicate statuses are allowed, but avoid them when you can.
- You can send an application's statuses in one request or across several requests.
- Send up to 25 dispositions per request. Split larger batches.
- Use real identifiers:
indeedApplyID,ittk,universalApplyId, andalternateIdentifier.
Integration phases
#Phase 1: Review
#Indeed stores the disposition data you send in a sandbox database. Indeed reviews the data to confirm that your integration works and that your status mapping is accurate.
Phase 2: Production
#Indeed stores the disposition data you send in the production database.
See also
#Guides
#- Partner Console > Credentials — Get your app's OAuth client ID and secret.
- Get an access token
- Send disposition data for Indeed Apply jobs
Reference
#- Indeed standard disposition statuses — The standard statuses, or hiring stages, to map your dispositions to.