Agency and Third Party integration with Indeed Apply

Setup steps for agencies and third-party platforms to integrate with Indeed Apply.

 

legal notice

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

Overview

These integration instructions are for Agencies:

• If you integrate your Agency platform or a third-party platform with Indeed, your clients or the clients of that third-party platform can enable Easily Apply on their job posts and send applicant information to the correct platform. Indeed Apply improves the job seeker experience and helps your clients hire faster.

• Before you integrate your Agency platform or a third-party platform with Indeed Apply, you must have an Indeed Partner Developer Agreement with Indeed.

Requirements

To integrate your Agency platform or a third-party platform with Indeed Apply, you need:

• A signed Developer Agreement between your company and Indeed. All integration builds must go through our formal integration request channel on Become an Indeed partner.
• A software developer who knows your systems and HTTP, XML, and JSON.
• A way, such as FTP access, to publish and refresh the XML feed that you build.
• A way to publish screener questions for Job Listings from your system to an HTTPS URL.
• An Indeed Apply API token. See Generate an API token.

Estimated time to develop and deploy

Based on experience with hundreds of integrated partners, this process usually takes six weeks to configure, test, review with Indeed team members, and deploy for client adoption.

An XML integration requires you to configure and publish an XML feed to Indeed on a regular schedule. This feed lets you control how key details about your clients’ Job Listings appear on Indeed. To enable Indeed Apply on Indeed.com, append metadata to each job in the feed. This metadata lets you show screener questions in the Indeed Apply application flow and specify where candidate information is sent in your system. After you configure the XML feed with Indeed Apply metadata and optional screener questions, Indeed reviews the feed for technical quality assurance and policy compliance.

Work with the Indeed Integrations Delivery team to choose a method for publishing and updating the feed and to review Indeed’s feedback and any required fixes.

Roadmap

Complete these XML feed-based integration steps:

1. Generate an API token
2. Create an XML feed
3. Configure Indeed Apply for your jobs
4. Add Indeed Apply screener questions
5. Receive application data from Indeed
6. Test your Indeed Apply configuration
7. Monitor integration health
8. Submit your XML feed for review
9. Send disposition data to Indeed

Generate an API token

When you become an Indeed partner, Indeed sets up an app that integrates Indeed APIs and services into your product. To view your app and its Indeed Apply API token credentials, sign in to Partner Console. Your API token credentials are a client ID and secret. Provide this API token for each job that you post to Indeed.

Create an XML feed

To configure Indeed Apply for your Agency platform or a third-party platform, create and maintain an XML feed. An XML feed is an XML document that defines your jobs and how they appear on the Indeed site.

When your customers create job listings in your system, those listings go from your XML feed directly to the Indeed XML feed.

An XML feed includes:

XML feed

Item	Define
Basic feed nodes	General XML feed details, including the XML version and encoding, and Agency platform or third-party platform information, as applicable.
Job feed elements	Job-specific details. Include one set of these elements 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.

See also:

• createSourcedJobPostings
• XML job feed
• updateSourcedJobPostings
• Indeed job details page

See the Job Sync XML feed reference.

Configure Indeed Apply for your jobs

To let job seekers apply quickly on Indeed, use the Easily apply feature through Indeed Apply.

Jobs with the Easily apply feature receive 12% more clicks. Indeed Apply also lets job seekers use their Indeed Resume, which further simplifies the application process.

To configure Indeed Apply for your jobs:

1. Add Indeed Apply configuration parameters to an <indeed-apply-data> element for jobs in your XML feed.
2. Set a postUrl value in the <indeed-apply-postUrl> parameter to accept applications from Indeed.
3. Confirm that your system can parse and handle the application data as needed.

For configuration parameters, see Indeed Apply configuration parameters.

For the <indeed-apply-data> element, see Indeed Apply XML feed with <indeed-apply-data> element example.

For more information about the Easily apply feature, see Policy - Indeed Apply and What does easily apply mean?

Add Indeed Apply screener questions

Screener questions let employers quickly determine whether an applicant meets their criteria. Adding screener questions to jobs helps employers focus on connecting with candidates instead of vetting them.

Indeed does not host screener questions for you. If your system supports screener questions, you must implement them in Indeed Apply for your integration to be approved.

To show screener questions in the Indeed Apply application flow, you can either:

• Format them in JSON and host them at an HTTPS URL that you include in each <job> in the <indeed-apply-questions> parameter under the <indeed-apply-data> element.

  For details, see:

  • Indeed Apply XML feed with <indeed-apply-data> element example
  • Indeed Apply configuration reference

• Call the Job Sync API to create a job posting with screener questions.

In January 2024, Indeed introduced schema versions for screener question configuration. As Indeed adds features, it makes minor upgrades to the version. The Application payload shows the schema version as 1.X, such as 1.1, 1.2, and so on. To support major and minor upgrades without breaking your integration, we recommend that you keep this value flexible. You do not have to match the minor schemaVersion in the screener question JSON.

Considerations

• You can ask a maximum of 500 questions.

  Conversion drops sharply when you ask more than 20 questions.

• Questions files can be up to 1 MB.

• Indeed caches question files on the server for unique question URLs. Indeed refreshes them every 24 hours, or sooner if new requests arrive after the cache age exceeds one hour.

• Indeed does not allow employer requests for unnecessary personally identifiable information (PII) in a job description or during the application process. For more information, see Policy - Personally Identifiable Information (PII).

When a job seeker starts the Indeed Apply process and Indeed requests questions, Indeed caches the questions.

JSON for screener questions

For a list of parameters and examples of specific question types, see Screener questions.

Receive application data from Indeed

To receive application data from Indeed, specify a URL in the feed for each job.

Indeed sends candidate information for that job to this URL as JSON documents.

Application delivery

To process applications programmatically, specify a URL where Indeed Apply sends a POST request. The <indeed-apply-postUrl> parameter defines the URL where Indeed posts the application data. This URL must use HTTPS.

postUrl example

_indeed-apply-postUrl

Confirm that your system returns an HTTP 2XX status code for every application that it receives successfully. Indeed Apply treats any other HTTP status code, post timeout, or connection timeout as a failure.

If Indeed does not receive an HTTP 2XX status code because of a connection timeout, post timeout, or invalid HTTP response, Indeed retries the application. Indeed uses exponential backoff for automatic retries. If delivery still fails after the last automatic retry, Indeed terminally fails the application.

Partners should not validate the content of the job application during the POST. If you want to validate the job content and disqualify the applicant, do that downstream of the POST. If partner validation of job seeker data causes HTTP failures, Indeed Apply might be disabled for the company where the application was submitted or for the entire feed.

See the Application delivery reference.

Do not redirect the POST request to another URL, such as through a 301 or 302 redirect. Indeed Apply does not support redirects.

Duplicate applications

For the purposes of responding to the POST, treat an application as a duplicate only if it is for the same job ID and from the same job seeker email as an Indeed application within the last 120 days.

Do not use applications originally submitted from a source other than Indeed to determine whether an application is a duplicate when responding to the POST. Likewise, do not treat applications from the same job seeker email to a different job ID at the same company as duplicates.

Application data

Because Indeed sends application data as the raw body of the HTTP POST request, your system cannot process the request like a typical form. The request body contains a JSON document that your system must read and parse. Indeed does not provide all JSON fields, so use a robust JSON parser that treats missing fields as empty and ignores unrecognized fields.

A JSON data payload has no maximum size.

The POST body uses UTF-8 encoding and includes an authenticity header that lets you verify that Indeed sent the application.

A file portion of the Applicant field contains these fields: contentType, data, and fileName.

Indeed determines contentType from the fileName.

The data field contains the raw resume file, encoded in Base64.

The third party must support these file types: .txt, .pdf, .doc, .docx, and .rtf.

If the third party already has a saved version of the resume in its system, it must still store and use the updated version in the application JSON.

For application data details, see the Application data reference.

Authentication of the POST request

Indeed Apply sends a POST request to your postUrl with an HTTP header that lets you verify that the POST is authentic.

Using the shared API secret for the Indeed Apply credential type, Indeed uses the HMAC-SHA1 algorithm to compute a message signature. Indeed sends this signature as an HTTP X-Indeed-Signature header.

To generate signatures, Indeed Apply uses the full unaltered JSON payload, including the curly brackets ({}), and the shared secret.

For code examples that show how the message signature is generated, see the Message signature generation reference.

Supported SSL certificates

For supported certificates, see the Trusted root SSL certificates.

If your certificate is not on the list, contact the Integrations Delivery Team.

Test your Indeed Apply configuration

Indeed provides a number of tools that enable you to test the components of your Indeed Apply integration.

To identify and proactively correct integration issues, review these topics to learn about the available testing tools and resources.

Test Indeed Apply application flow and applicant delivery

To test your integration setup and confirm that everything works smoothly before you push a job or integration live, use the Apply XML configuration testing tool.

You can enter your Indeed Apply XML metadata for a job into the tool, or the tool can generate XML metadata for you from several configurable parameters. The tool identifies formatting and content errors so you can quickly find issues.

If the tool detects no errors, it shows the Start testing button. Select it to preview the application process as a job seeker and submit a test application to confirm that the process works correctly. If your postUrl is valid, the test application sent to the postUrl with the application data payload can help you confirm that your system parses the JSON document correctly and that applicant information appears in your system as expected.

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 Indeed Apply application flow. The Configuration section in this tab also lists every parameter included 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

Apply XML configuration testing tool - XML tab

The tool also flags errors in your metadata that can break Indeed Apply. For example, the tool detects a missing required parameter or an incorrectly formatted file. In either case, the tool shows an alert.

Example: Incorrect parameter format error

Example: Incorrect parameter format error

Example: Missing parameter error

Example: Missing parameter error

The second tab of the Apply XML configuration testing tool 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 with the information you provide.

After the tool generates the metadata, add it to your XML feed. For an example, see Create an XML feed.

Apply XML configuration testing tool - Configurable parameters tab

Indeed Apply XML configuration testing tool

Beyond the default parameters, you can add more parameters 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 within the Indeed Apply tags to walk through the application experience and post the application to the URL you specified in the tool's sample data.

Test your Indeed Apply screener questions

You can also use the Indeed Apply Questions tool to verify the syntax of your Screener Questions JSON file. This tool shows how screener questions appear in the Indeed Apply application flow.

Indeed Apply Questions tool

Indeed Apply Questions tool

You can paste your entire JSON file into the main field of this interactive tool to highlight errors in formatting.

Error message examples

Error message examples

Right-click on the editor to run basic text commands.

Basic text commands

Basic text commands

For more advanced commands, such as those in VS code, select Command Palette or press F1.

More advanced commands

More advanced commands

The tool also includes a link to this documentation so that you can reference the relevant JSON parameters as needed.

After your JSON appears to be formatted correctly, select Start testing to see a preview of how your screener questions appear to job seekers.

Monitor integration health

When you integrate with Indeed Apply, set up monitoring to ensure that:

• The integration successfully delivers job applications.
• Questions files are valid and consistently available.

Indeed also monitors whether applications reach agency platforms or third-party platforms successfully, along with other integration health indicators. If problems arise, Indeed might contact you. In some cases, Indeed can disable the Indeed Apply feature for some or all of your feed’s job listings until you correct the issues. Indeed does not lose undelivered applications. If delivery fails, Indeed retries automatically at periodic intervals after the original application is submitted. If delivery remains impossible, Indeed retains applications for 60 days, and you can request additional retries by contacting the Integrations Delivery Team.

If your integration supports screener questions, confirm that the pages that host those files are consistently available, do not redirect, and are properly formatted.

Submit your XML feed for review

When development is complete, submit your XML feed to your technical point of contact for review, or request support from Partner Console.

Send disposition data to Indeed

Disposition data is information about updates to an application in your agency platform or a third-party platform.

An update can be a change in a recruiter's workflow or an action that a recruiter or candidate takes after the candidate applies. For example, a candidate is hired.

When you send disposition data to Indeed, your clients receive higher-quality applications over time.

See the Disposition Sync API Guide.

 

Was this page helpful?