Integrate with the Disposition Sync API

Integrate with the Disposition Sync API.

 

legal notice

By using this API and its documentation and building an integration, you agree to the Additional API Terms and Guidelines.

Disposition Sync API overview

Use the Disposition Sync API to send disposition data for Indeed Apply and non-Indeed Apply jobs to Indeed.

Disposition Sync API integration is required to submit disposition data to Indeed.

Before you integrate

Only partners who have signed a Developer Agreement with Indeed are intended to integrate with Indeed. This guide helps you plan your integration.

To integrate the Disposition Sync API:

Disposition Sync API integration steps

#	Step	See
1.	When you become an Indeed partner, Indeed sets up an app that integrates Indeed APIs and services into your product. You can use Partner Console to access your app's OAuth credentials: a client ID and secret.	Credentials
2.	Exchange the client ID and secret for an access token, which you use for authentication when you call the Disposition Sync API. The token expires after one hour.	Get an access token
3.	For all Indeed-sourced applications, Indeed requires that you send ATS disposition data to Indeed. Indeed requires at least one disposition sent with dispositionStatus set to NEW, which corresponds to when the ATS received the application.	Indeed standard disposition statuses
4.	To use the Disposition Sync API to submit disposition data to Indeed, set each disposition to the Indeed standard disposition status that best represents it.
5.	As applications transition through disposition statuses, use the Disposition Sync API to send these statuses. Indeed encourages you to send the disposition data each time a change occurs in your system. Alternatively, you can send disposition data on a scheduled, periodic basis, but at least once a day.	Send disposition data for Indeed Apply jobs
6.	Before you send disposition data, sort all data sent in a single request by the status change timestamp in ascending order.
7.	It is acceptable to send duplicate disposition statuses for an application. However, avoid this practice when possible.
8.	Send multiple unique disposition statuses for an application in one or multiple requests to the API.
9.	When possible, combine requests by sending multiple dispositions in one API request. However, send a maximum of 25 dispositions in one request. If the amount of dispositions exceeds this threshold, split them into multiple requests.
10.	When you call the Disposition Sync API, use real identifiers as inputs, including indeedApplyID, ittk, universalApplyId, and alternateIdentifier. Note: Indeed Tracking Token Key (ITTK), ApplyID, and alternate identifiers are not available in Japan.	PartnerDispositionIdentifierInput

Integration phases

Integration with the Disposition Sync API occurs in two phases:

Disposition Sync API integration phases

#	Phase	Description
1	Review	When you use the Disposition Sync API to send disposition data to Indeed, Indeed stores the data in the sandbox database. Indeed reviews the data to ensure that the integration works as expected and the disposition status mapping is accurate.
2	Production	When you use the Disposition Sync API to send disposition data to Indeed, Indeed stores the data in the production database.

 

Was this page helpful?