- Overview
- 1. Complete the integration prerequisites
- 2. Authenticate
- 3. Configure Indeed Apply for your jobs
- 4. Add Indeed Apply screener questions
- 5. Receive application data from Indeed
- Duplicate applications
- Application data
- Authentication of the POST request
- Supported SSL certificates
- 6. Code your integration
- 7. Validate and test your integration
- 8. Confirm your integration
- 9. Monitor integration health
- 10. Send disposition data to Indeed
- See also
- Guides
- References
- FAQs
- Tools and support
- GraphQL API reference
Job Sync API integration guide
Integrate the API to create and manage job postings on Indeed.
By using this API and its documentation and building an integration, you agree to the Additional API Terms and Guidelines.
Overview
#Use the Job Sync API to create and manage job postings on Indeed and Indeed PLUS.
This integration usually takes about six weeks to set up, test, review with Indeed, and deploy for your clients.
-
jobRequisitionIdis optional in the schema, but Indeed requires it when it differs fromjobPostingId.For Japanese job postings: Set it to the same value as the ID or
jobPostingId. -
Hiring manager and recruiter values in
SourcedJobPostingJobContactInputare optional in the schema, but Indeed requires them when available.
1. Complete the integration prerequisites
#Before you integrate, complete these steps:
-
Collect your clients' names and send them to Indeed.
Indeed helps you review existing client names. Later, use those names in
SourcedJobPostingJobSourceInput.sourceName. -
Review the Indeed Developer Agreement, then apply through Become an Indeed partner (opens in a new window). Indeed reviews your application and checks your integration build. During onboarding, Indeed sends you the agreement to sign.
After Indeed approves your account, it gives you access and sends you a questionnaire about:
- Your plan to review Indeed Apply and screener questions.
- Your target go-live dates.
- Your business contact and lead developer or engineering manager.
- Your estimated job volume, including client count and total jobs.
- Whether your clients are employers or staffing agencies.
- Your planned integration pattern.
-
Send each job with its public job description page URL.
Indeed crawls this URL to confirm that it matches the job you send. Without it, your integration review can take longer.
Provide these logs to Indeed for troubleshooting.
Job Sync API integrations must be comprehensive: for each client, send every job on the client's career page. A client can opt out. If it does, expire all of its jobs and stop sending them.
When a job is added, updated, or expired on a client's career site, send the change right away. If Indeed doesn't get the update within 15 minutes, the job can lose visibility. When you first send existing jobs, send them in batches of fewer than 100.
2. Authenticate
#When you become an Indeed partner, Indeed creates an app for your integration. Sign in to Partner Console (opens in a new window) to view the app and your OAuth credentials: client ID and secret. Exchange those credentials for an access token to authenticate API calls.
3. Configure Indeed Apply for your jobs
#When you integrate your ATS with Indeed Apply, your clients can turn on Easily apply for their jobs, and Indeed sends applications to their ATS. Indeed Apply makes applying easier for job seekers and can help clients hire faster.
To test Indeed Apply end to end, add it to a sandbox job, which is a job that you send with the sandbox source that Indeed provides. Then open the job directly and apply to it. Include screener questions in your test.
To configure Indeed Apply:
-
Set the Indeed Apply fields in
SourcedJobPostingIndeedApplyInput.To receive application data from Indeed, set
postUrlto the URL where Indeed sends application data. -
Verify that your system can parse and process the application data.
4. Add Indeed Apply screener questions
#Screener questions show employers whether applicants meet their criteria, so they spend less time screening.
Indeed doesn't host screener questions. If your system supports them, add them to Indeed Apply. Indeed doesn't approve your integration without them.
To add screener questions to the Indeed Apply flow, see Create job posting with screener questions.
5. Receive application data from Indeed
#To receive application data, set a URL for each job. Indeed sends the job's candidate information to this URL as JSON.
To process applications automatically:
-
Receive application data at the HTTPS URL you define in
postUrl.For example:
"postUrl": "https://www.example.com/jobs" -
Return an HTTP
2XXstatus code for every application that your system receives. Indeed treats any other status code, aPOSTtimeout, or a connection timeout as a failure.If Indeed doesn't get a
2XXstatus code, it retries with exponential backoff. If the last retry fails, Indeed marks the application as failed.Don't validate the application during the
POST. Accept thePOSTfirst, and then validate the application or disqualify the applicant. If your validation causes errors, Indeed might turn off your integration.Do not redirect the
POSTrequest to another URL, such as with a301or302response. Indeed does not support redirects. See HTTP status codes.
Duplicate applications
#Treat an application as a duplicate only if both of these are true:
- It uses the same job ID.
- It uses the same job seeker email address as an Indeed application from the last 120 days.
Don't count applications from other sources. An application from the same email to a different job at the same company isn't a duplicate.
Application data
#Indeed sends application data as JSON in the raw body of the POST request, not as form data, so read and parse the JSON. Not every application includes every field. Use a JSON parser that treats missing fields as empty and ignores unknown fields.
The JSON payload has no maximum size.
The POST body uses UTF-8 encoding. A request header lets you verify that Indeed sent it.
The file section of the Applicant field contains contentType, data, and fileName:
- Indeed determines
contentTypefromfileName. datacontains the raw resume file in Base64 encoding.- Third-party systems must support these file types:
.txt,.pdf,.doc,.docx, and.rtf.
For details, see the Application data reference.
Authentication of the POST request
#To let you verify each POST request to your postUrl, Indeed signs the request. It computes the signature with the HMAC-SHA1 algorithm and your Indeed Apply shared API secret, and sends it in the X-Indeed-Signature header. The signature covers the full, unaltered JSON payload, including the curly braces ({}).
For code examples, see the Message signature generation reference.
Supported SSL certificates
#For supported certificates, see Trusted root SSL certificates.
If your certificate isn't listed, contact the Integrations Delivery Team (opens in a new window).
6. Code your integration
#To code your integration:
When Indeed turns on your API access, it gives you a source name. For all test jobs, set
SourcedJobPostingJobSourceInput.sourceNameto that name.Indeed can't validate test jobs that use any other source name, and you must expire them before you send real jobs.
Make test jobs look like real jobs. For example, don't use titles such as Fake test job, and include a real job description. Job seekers can't see jobs that you send with the sandbox source.
When your test jobs have no errors, review your sandbox jobs. On the Indeed Employer (opens in a new window) page, sign in with the account that you used to register your app, and then select the Jobs tab.
After Indeed validates your test jobs, it tells you to send your existing jobs and live job updates for review.
Before you validate and test your integration, set
sourceNamein every real job to the organization that owns the job. Don't use your test source name for real jobs.During testing, Indeed can give you the
sourceNamevalues for the organizations that own your jobs. Use those values. Otherwise, clients might not find their jobs on Indeed.For more guidance, see How do I distinguish employers in job postings?
7. Validate and test your integration
#To validate and test your integration:
Confirm that sending your current job list returns no common GraphQL error codes.
Confirm that HTML in the
descriptionfield isn't escaped.Include jobs from all of your clients' companies.
Indeed already knows about most jobs, so missing companies can delay go-live.
Include all jobs available on your clients' career sites.
Include jobs from the parent company's sub-brands and subsidiaries. If the number of jobs on career sites and in your integration differs, your jobs can lose visibility.
Give every job a unique URL in the
urlfield.Confirm that job salaries, locations, and other metadata match the jobs on your career site.
Confirm that each job's
jobRequisitionIdmatches the requisition ID on your career site.Split jobs with multiple locations or languages into unique job postings:
- Post one job posting for each position-location pair.
- Post one job posting for each position-language pair.
These job postings can share the same
urlandjobRequisitionId, but each needs a uniquejobPostingId.Provide hiring manager or recruiter email addresses when available.
Expire all test jobs that you created during development.
Keep your jobs updated so that they match your clients' career sites, including job type, job category, and full address.
Before launch, Indeed compares your jobs with the career sites. Launch waits until your integration sends the same data that the career sites show.
Complete the Indeed Apply checklist that Indeed shares with you.
To test HTTP errors, use the HTTP codes / Security for post requests row in the checklist.
Use Indeed Apply Integration Tools: Test Indeed Apply Questions (opens in a new window) to validate screener question formatting and verify your
postUrl.
8. Confirm your integration
#When your integration meets these requirements, submit documentation with screenshots that show:
- Indeed branding and placement in the employer's integration menu
- How an employer submits a job with Indeed Apply
- How employer job analytics show source tracking for Indeed applicants
- How an employer disables Indeed Apply for jobs
Indeed reviews your integration and emails you after it approves it.
9. Monitor integration health
#If you integrate with Indeed Apply, set up monitoring to confirm that:
- Job applications are delivered successfully.
- Question files are valid and consistently available.
Indeed also monitors application delivery and other signs of integration health. If problems come up, Indeed might contact you, and in some cases turns off Indeed Apply for some or all of your jobs until you fix them.
Indeed does not lose undelivered applications. If delivery fails, Indeed retries automatically. If the retries also fail, Indeed keeps the applications for 60 days. To request more retries, contact the Integrations Delivery Team (opens in a new window).
If your integration supports screener questions, make sure that the question file URLs are always available, don't redirect, and return correctly formatted JSON.
10. Send disposition data to Indeed
#Disposition data describes updates to an application in your ATS after the candidate applies. An update can be a change in a recruiter's workflow, or an action that a recruiter or candidate takes, such as a hire. Sending disposition data helps your clients get better applications over time.
See the Disposition Sync API guide.
See also
#Guides
#- Application data — Explains how to read application data from the raw body of the
POSTrequest, which you can't process like a form. - Application delivery — Explains how to receive applications at a URL that accepts
POSTrequests from Indeed Apply. - Authentication of the POST request — Explains how to use the HTTP header in each
POSTrequest to verify that it comes from Indeed. - Create job posting with screener questions — Explains how to show screener questions in the Indeed Apply flow.
- Disposition Sync API guide — Explains how to send application disposition data to Indeed.
- Duplicate applications — Explains when Indeed treats an application as a duplicate.
- Getting Started with Indeed Apply (opens in a new window) — Explains what Indeed Apply is and how to use it.
- Indeed Apply Policy (opens in a new window) — Explains how employers that use Indeed Apply must handle job seeker data and follow Indeed's standards.
- Job Sync API guide — Explains how to create and manage job postings on Indeed.
References
#- Application data reference — Lists the fields in the application JSON
POSTbody. - Common GraphQL error codes — Lists the GraphQL error codes that your job list must not return.
- HTTP status codes — Lists the status codes to return for the
POSTrequest. - Message signature generation reference — Gives code samples for generating message signatures.
- Trusted root SSL certificates — Lists the root SSL certificates that Indeed Apply trusts.
FAQs
#Tools and support
#- Become an Indeed partner (opens in a new window) — Submit a formal integration request.
- Indeed Apply Integration Tools: Test Indeed Apply Questions (opens in a new window) — Validate screener question formatting and verify your
postUrl. - Indeed Employer jobs page (opens in a new window) — Review your sandbox jobs.
- Integrations Delivery Team (opens in a new window) — Get help with SSL certificates that aren't listed, or request more application delivery retries.
GraphQL API reference
#SourcedJobPostingBodyInput.description— The job description, which can include HTML.SourcedJobPostingIndeedApplyInput.postUrl— The URL where Indeed Apply sends applications.SourcedJobPostingJobContactInputSourcedJobPostingJobSourceInput.sourceName— The source name that identifies the organization that owns the job.SourcedJobPostingMetadataInput— Job posting metadata, includingjobRequisitionIdandjobPostingId.