- Overview
- 1. Generate an API token
- 2. Create an XML feed
- 3. Configure Indeed Apply for your jobs
- 4. Add Indeed Apply screener questions
- Considerations
- JSON for screener questions reference
- 5. Receive application data from Indeed
- Application delivery
- Application data
- Authentication of the POST request
- Supported SSL certificates
- 6. Test your Indeed Apply configuration
- Test Indeed Apply application flow and applicant delivery
- Test your Indeed Apply XML metadata
- Test your Indeed Apply screener questions
- 7. Monitor integration health
- 8. Submit your XML feed for review
- 9. Send disposition data to Indeed
- See also
- Guides
- GraphQL API reference
Indeed Apply integration guide for ATS partners
Integrate with Indeed Apply for applicant tracking system (ATS) partners.
- By using this API and its documentation and building an integration, you agree to the Additional API Terms and Guidelines.
Overview
#This guide is for applicant tracking system (ATS) partners.
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 helps your clients hire faster.
To integrate with Indeed Apply, you need:
- A signed Developer Agreement between your company and Indeed. Submit each integration request through Become an Indeed partner (opens in a new window).
- A software developer who knows your systems and HTTP, XML, and JSON.
- A way to publish and refresh your XML feed, such as FTP.
- A way to publish screener questions to an HTTPS URL.
- An Indeed Apply API token.
Integrations usually take about six weeks to configure, test, review with Indeed, and deploy.
In an XML integration, you regularly publish an XML feed that controls how jobs appear on Indeed. To turn on Indeed Apply, add Indeed Apply metadata to each job. The metadata adds screener questions to the application and tells Indeed where to send candidate information.
After you add the metadata and screener questions, Indeed reviews the feed for technical quality and policy compliance.
Work with the Indeed Integrations Delivery (opens in a new window) team to choose how to publish and update the feed, and to review their feedback and required fixes.
1. Generate an API token
#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's Indeed Apply client ID and secret. The client ID is your Indeed Apply API token. Include it in each job that you post to Indeed.
2. Create an XML feed
#To configure Indeed Apply, create and maintain an XML feed: an XML document that defines your jobs and how they appear on Indeed. When your clients create jobs in your system, the feed sends them to Indeed.
An XML feed includes:
| Item | Defines |
|---|---|
Basic feed nodes | General feed details, including the XML version, encoding, and ATS information. |
Job feed elements | Job-specific details. Include one set for each job that appears on Indeed. |
If you create a job through either the createSourcedJobPostings mutation or an XML job feed, expiration of the job requires an action on your part. You must explicitly expire that job.
Even if someone calls the updateSourcedJobPostings mutation or clicks Edit on the Indeed job details page for this job, you must explicitly expire that job.
3. Configure Indeed Apply for your jobs
#Turn on Easily apply so that job seekers can apply quickly from Indeed, including with their Indeed Resume. Jobs with Easily apply get 12% more clicks.
To configure Indeed Apply for your jobs:
- For each job in your XML feed, add Indeed Apply configuration parameters to an
<indeed-apply-data>element. - Set
postUrlin<indeed-apply-postUrl>so that Indeed can send applications to your system. - Make sure that your system can parse 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, do one of these:
-
Host the questions as JSON at an HTTPS URL. In each
<job>, put that URL in<indeed-apply-questions>inside<indeed-apply-data>. -
Call the Job Sync API to create a job posting with screener questions.
Since January 2024, screener question configurations have a schema version, which the application payload shows as 1.X, such as 1.1 or 1.2. Indeed increases the minor version when it adds features, so don't hard-code this value. Your screener question JSON doesn't need to match the minor schemaVersion.
Considerations
#-
You can ask up to 500 questions.
Conversion drops sharply when you ask more than 20 questions.
-
Question files can be up to 1 MB.
-
Indeed caches the question file for each URL. It refreshes the cache every 24 hours. If a request arrives when the cache is more than 1 hour old, Indeed refreshes it sooner.
-
To clear the cache after you change the JSON or add resume field standardization, use a new question URL.
-
Employers can't ask for unnecessary personally identifiable information (PII) in a job description or application.
JSON for screener questions reference
#For parameter lists and examples of question types, see Screener questions.
5. Receive application data from Indeed
#To receive application data, set a URL for each job in the feed. Indeed sends the job's candidate information to this URL as JSON.
Application delivery
#To process applications automatically, set the <indeed-apply-postUrl> parameter to an HTTPS URL that accepts POST requests from Indeed Apply.
postUrl example
#indeed-apply-postUrl=https%3A%2F%2Fyourposturl.comReturn an HTTP 2XX status code for every application that your system receives. Indeed Apply treats any other status code, a POST timeout, or a connection timeout as a failure.
If Indeed doesn't get a 2XX status 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 the POST first, and then validate the application or disqualify the applicant. If your validation causes HTTP failures, Indeed might turn off Indeed Apply for the company or for your entire feed.
Don't redirect the POST request, such as with a 301 or 302. Indeed Apply doesn't support redirects.
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 sets contentType based on fileName. data contains the resume file, encoded in Base64.
Your system must support these file types: .txt, .pdf, .doc, .docx, and .rtf.
If your system already has a saved resume for the candidate, store and use the resume in the application JSON instead.
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. Test your Indeed Apply configuration
#Indeed provides tools to test the components of your Indeed Apply integration. Review these topics to find the available tools and fix integration issues early.
Test Indeed Apply application flow and applicant delivery
#Before you launch a job or integration, test your setup with the Apply XML configuration testing tool (opens in a new window).
Enter a job's Indeed Apply XML metadata, or let the tool generate metadata from parameters that you choose. The tool flags formatting and content errors.
If the tool finds no errors, it shows Start testing. Select it to apply as a job seeker and submit a test application. If your postUrl is valid, the tool sends the test application to it. Confirm that your system parses the JSON and shows the applicant information correctly.
Test your Indeed Apply XML metadata
#The first tab of the Indeed Apply XML configuration testing tool lets you enter Indeed Apply metadata from XML and review it in the application flow. The Configuration section lists every parameter in the XML so you can see your detected job elements.
For the supported parameters, see the Indeed Apply configuration reference.
Indeed Apply XML configuration testing tool - XML tab
#The tool also flags metadata errors that can break Indeed Apply, such as a missing required parameter or an incorrectly formatted file. In either case, the tool shows an alert.
Example: Incorrect parameter format error
#Example: Missing parameter error
#The second tab lets you fill in configurable parameters and generates the matching Indeed Apply XML metadata. You can also preview how the job appears in the application flow.
After the tool generates the metadata, add it to your XML feed. For an example, see Create an XML feed.
Indeed Apply XML configuration testing tool
#Beyond the default parameters, you can add more from a list of options. After you select and fill them in, the tool adds them to the generated XML.
This tool lets you mock up your Indeed Apply integration. Provide your postUrl in the Indeed Apply tags to walk through the application experience and post the application to that URL with the tool's sample data.
Test your Indeed Apply screener questions
#Use the Indeed Apply Questions tool (opens in a new window) to check the syntax of your screener questions JSON and see how the questions appear in the Indeed Apply flow.
Indeed Apply Questions tool
#Paste your JSON into the tool's main field to highlight formatting errors.
Error message examples
#Right-click in the editor to run basic text commands.
Basic text commands
#For more advanced commands, like those in VS Code, open the Command Palette or press F1.
More advanced commands
#The tool also links to this documentation, where you can look up JSON parameters.
When your JSON has no errors, select Start testing to preview your screener questions as a job seeker.
7. Monitor integration health
#Set up monitoring to confirm that:
- Your integration delivers job applications successfully.
- Your question files are valid and always 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 feed's jobs until you fix them.
Indeed doesn't 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.
8. Submit your XML feed for review
#When development is done, send your XML feed to your technical contact for review, or request support in Partner Console.
9. 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 reference — Field reference for the application JSON
POSTbody. - Application delivery reference — HTTP status codes to return in your
POSTresponse. - Apply XML configuration testing tool (opens in a new window) — Test a job's Indeed Apply XML metadata and submit a test application.
- Become an Indeed partner (opens in a new window)
- Disposition Sync API guide — Send application disposition data to Indeed.
- How do I get a signed Developer Agreement?
- Increase candidate quality, hire more efficiently (opens in a new window) — How Indeed Apply helps you get more relevant candidates faster.
- Indeed Apply configuration parameters — Restrictions to follow when you configure Indeed Apply in the XML feed.
- Indeed Apply configuration reference — Parameters, examples, and restrictions for Indeed Apply in the XML feed.
- Indeed Apply Policy (opens in a new window) — Indeed Apply lets people apply for jobs directly on Indeed.
- Indeed Integrations Delivery (opens in a new window) — Work with Indeed to publish your feed and review fixes.
<indeed-apply-postUrl>— The HTTPS URL where Indeed Apply sends applications.- Integrations Delivery Team support (opens in a new window) — Contact Indeed about certificates and delivery retries.
- Job Sync API guide > Create job posting with screener questions — Send screener questions with a job posting through the Job Sync API.
- Job Sync API guide > Job details page (signed in to Indeed) — How a job's searchable status appears on the job details page.
- Job Sync XML feed guide — Use an XML feed to define your jobs and how they appear on Indeed.
- JSON for screener questions reference — Parameters for screener questions in JSON.
- Maintaining User Safety (opens in a new window) — How Indeed keeps job seekers safe and protects their personal information.
- Message signature generation reference — Code samples for generating message signatures.
- Partner Console (opens in a new window) — Get your Indeed Apply credentials and request support.
- Trusted root SSL certificates — Root SSL certificates that Indeed Apply trusts.
- XML feed with <indeed-apply-data> — Example feed with one job and an
<indeed-apply-data>element.
GraphQL API reference
#createSourcedJobPostings— Submits a job posting to Indeed.updateSourcedJobPostings— Updates a sourced job posting. Claim the job source first.