- Integration overview
- 1. Sign a Developer Agreement with Indeed
- 2. Authenticate
- 3. Create an XML feed
- 4. Configure Indeed Apply for your jobs
- 5. Add Indeed Apply screener questions
- Schema versions
- Considerations
- 6. Receive application data from Indeed
- Application delivery
- Application data
- Authentication of the POST request
- Supported SSL certificates
- 7. 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
- 8. Monitor integration health
- 9. Submit your XML feed for review
- Pre-submission checklists
- 10. Send disposition data to Indeed
- See also
- Guides
- GraphQL API reference
Indeed Apply integration guide for direct employers
Integrate with Indeed Apply, for direct employers and third parties acting on their behalf.
- By using this API and its documentation and building an integration, you agree to the Additional API Terms and Guidelines.
Integration overview
#This guide is for direct employers. Follow it if you send an XML feed, with or without Indeed Apply.
Your XML feed controls how your jobs appear on Indeed. Adding Indeed Apply lets job seekers apply more easily, which can help you hire faster.
If you have questions, contact your Client Success representative. If you don't have one, use this web form (opens in a new window).
To integrate with Indeed Apply, you need:
- A signed Developer Agreement between your company and Indeed. See 1. Sign a Developer Agreement with Indeed.
- 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.
- Single requester rule: Only the party that builds the integration can request and hold the API key or SFTP credentials. Indeed doesn't allow proxy requests, where an employer requests a key for a third-party integrator.
Integrations usually take about six weeks to configure, test, review with Indeed, and deploy.
In an XML integration, you regularly publish an XML feed to 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 your Client Success representative to set up feed publishing and updates, and to review their feedback and required fixes.
1. Sign a Developer Agreement with Indeed
#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 integration.
2. Authenticate
#Japan only
#- Sign in to your Indeed account on Manage app credentials (opens in a new window), then select Register new application.
- Enter your app name and description, select Indeed Apply as the credential type, then select Save and continue.
- Select Complete registration.
To get your Indeed Apply token, return to Manage app credentials. Use the client ID as the token.
Outside of Japan
#To build an Indeed Apply XML integration, contact the Indeed Client Success team (opens in a new window). After you sign the Developer Agreement, Indeed creates an app that connects Indeed APIs and services to your product.
To view your app and Indeed Apply API token, sign in to Partner Console (opens in a new window):
- Use the client ID and client secret as the API token credentials.
- Include this API token in each job you post to Indeed.
3. 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 you create jobs in your system, the feed sends them to Indeed.
An XML feed includes:
- Basic feed nodes — Define general feed details, such as the XML version and encoding.
- Job feed elements — Define job-specific details. Include one set of these elements for each job that you want to appear 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.
4. Configure Indeed Apply for your jobs
#Turn on Easily apply so that job seekers can apply quickly on 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.
5. 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:
- Format your questions in JSON.
- Host them at an HTTPS URL.
- In each
<job>, put that URL in<indeed-apply-questions>inside<indeed-apply-data>.
Schema versions
#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.
-
Keep the questions file under 1 MB.
-
Use a unique URL for each question file. Indeed caches each file and refreshes it 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.
-
Don't ask for unnecessary personally identifiable information (PII) in a job description or application.
6. 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 receive 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 HTTP 2XX for every application you receive. If the JSON payload is missing a required key, return HTTP 400 instead. Indeed Apply treats any other status code, or a POST or connection timeout, as a failure.
After a failure, Indeed Apply retries with exponential backoff. If the last retry fails, it marks the application as failed.
Accept the POST first, and validate the application or disqualify the applicant afterward. If your validation causes HTTP failures, Indeed might turn off Indeed Apply for the company or for your whole feed.
Don't redirect the POST request, for example 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 employer 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 your Client Success representative.
7. Test your Indeed Apply configuration
#Use Indeed's testing tools to find issues in your integration 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
#On the tool's first tab, enter the Indeed Apply metadata from your XML and review it in the application flow. The Configuration section lists the parameters that the tool found in the XML.
Indeed Apply XML configuration testing tool - XML tab
#The tool also shows an alert for each metadata error that can make Indeed Apply fail, such as a missing required parameter or a formatting issue.
Example: Incorrect parameter format error
#Example: Missing parameter error
#On the second tab, enter parameters to generate the matching Indeed Apply XML metadata, and preview the job in the application flow. Then add the metadata to your XML feed.
Configuration testing tool - Configurable parameters tab
#To add more parameters, select them from the list and fill them in. The tool adds them to the generated XML.
If you include your postUrl, you can apply as a job seeker and send a test application to it.
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 application 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.
8. 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 your Client Success representative.
If your integration supports screener questions, make sure that the question file URLs are always available, don't redirect, and return correctly formatted JSON.
9. Submit your XML feed for review
#To avoid delays, complete these checklists before you send your XML feed to your Client Success representative.
Pre-submission checklists
#XML file
#| Checklist | Confirm (Yes/No) |
|---|---|
Include all basic feed nodes, including the XML version and encoding: | |
Include a | |
Include every company associated with the jobs. | |
Don't include test jobs. | |
URL-encode all metadata URLs in the XML file, including | |
Don't include HTML escape characters such as | |
Include salary tags on all jobs. | |
Make sure that the external ID matches the career site content. | |
Include an |
Indeed Apply - Screener questions
#| Checklist | Details | Confirm (Yes/No) |
|---|---|---|
XML content | Include Indeed Apply parameters in each | |
URL-encode all URLs in the Indeed Apply parameters, including | ||
Send | ||
HTTP codes / Security for POST requests | Return HTTP | |
Return HTTP | ||
Return HTTP | ||
Return HTTP | ||
Return HTTP | ||
Return HTTP | ||
Verify the | ||
Use HTTPS for the Indeed Apply | ||
Alerts and logging | Set up alerts for failed Include in your
Provide an example of these logs as a screenshot or text file. | |
Set up alerts for failed Include in your screener question logs:
Provide an example of these logs as a screenshot or text file. | ||
Job seeker application data delivery | Get the candidate's first and last name from | |
Capture and store uploaded resume files correctly. See the example. | ||
Capture and store Indeed Resume files correctly. See the example. | ||
Don't limit the application payload size. | ||
Screener questions | Follow the best practices for screener questions. | |
Capture and store cover letters and other documents in the application. See Applicant fields. | ||
Don't ask for PII, such as a full Social Security number (SSN), in screener questions. | ||
General requirements | Set the source of Indeed Apply applications to "Indeed". | |
Use the analytics field to categorize applications as organic, sponsored, or Indeed Targeted Ad. | ||
Make sure that your SSL certificate is valid and current. |
10. Send disposition data to Indeed
#Disposition data describes updates to an application in your system after the candidate applies, such as a hire. Sending disposition data helps you get better applications over time.
See the Disposition Sync API guide.
See also
#Guides
#- Application data reference — Fields in the application JSON
POSTbody. - Application data reference > analytics object fields — Fields that show whether an application is organic, sponsored, or from an Indeed Targeted Ad.
- Application data reference > applicant object fields — Fields that describe the applicant.
- Application data reference > Application payload with Indeed Resume example — Example
POSTbody when the applicant applies with an Indeed Resume. - Application data reference > Application payload with resume upload example — Example
POSTbody when the applicant uploads a resume file. - 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)
- Contact Indeed (opens in a new window) — Web form for employers without a Client Success representative.
- 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 reference — Parameters, examples, and restrictions for Indeed Apply in the XML feed.
- Indeed Apply configuration reference > indeed-apply-postUrl — The URL that Indeed sends applications to.
- Indeed Apply Questions tool (opens in a new window) — Check your screener questions JSON and preview the questions.
- 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.
- Job Sync XML feed guide > Basic feed nodes — General feed details, such as the XML version and encoding.
- Job Sync XML feed guide > job — The
<job>node for each job in the feed. - Job Sync XML feed guide > Job feed elements — Elements that describe each job.
- JSON for screener questions reference — Parameters for screener questions in JSON.
- JSON for screener questions reference > Best practices — Guidelines for writing screener questions.
- 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.
- Policy - Indeed Apply (opens in a new window) — Indeed's policy for applying to jobs directly on Indeed.
- 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.