Indeed Apply configuration parameters and examples.

Indeed Apply configuration parameters

Restrictions

When you use the XML feed to configure Indeed Apply, conform to these restrictions:

  • URL-encode parameters. Do not URL-encode the & and = characters.

    For example, &indeed-apply-jobId=Sample+ID&indeed-apply-jobCompanyName=My+Favorite&

  • Ensure that any Indeed Apply parameter in the feed has a value. Otherwise, errors occur.

  • Elements are not case-sensitive.

    For example, <indeed-apply-jobCompanyName> and <indeed-apply-jobcompanyname> are equivalent.

  • Begin all Indeed Apply configuration parameters with <indeed-apply-.

    The Indeed Apply element wraps the configuration settings within a CDATA section to eliminate any line breaks and extra whitespace.

Indeed Apply configuration parameters table
Parameter Description Example

indeed-apply-jobUrl

Canonical URL to the complete job description. Encode this URL in XML files.

📘 Note:

For applications on Indeed, the jobUrl is set in the apply button to the URL on Indeed where the apply occurs.

https%3A%2F%2Fwww.yourcompany.com
%2F%0Acareers%2Fyourjob123.html

indeed-apply-jobId

ID of the job, used for your own internal tracking.

Used for Indeed Apply applications and to identify whether the application is a duplicate. The description of the 409 status code mentions this job ID.

📘 Note:

Contains a maximum of 256 ASCII characters.

7775e2bc62b7f77e

indeed-apply-jobTitle

Required

The title of the job to display externally.

📘 Note:

Must match the <title> field value in the XML.

Test Engineer

indeed-apply-jobCompanyName

Required

The name of the company.

📘 Note:

Must match the <company> field value in the XML.

Your Company

indeed-apply-jobLocation

Required

Location of the job.

<city>, <state>, and <country> are required components of this field.

New York, NY 10110

indeed-apply-jobMeta

Additional information. This information does not appear externally, but is sent when using apply through the post URL.

right-rail-apply-button

indeed-apply-apiToken

Required

Client ID value that you receive when you request Indeed Apply credentials.

See generate an API token.

your-api-token

indeed-apply-postUrl

Required

URL to which Indeed posts the application data. Encode this URL in XML files. Must be HTTPS.

https%3A%2F%2Fwww.yourcompany.com
%2Fprocess-applications

indeed-apply-phone

String. Indicates whether to show the phone number field on the job.

Valid value is optional, hidden, or required.

Default is optional.

optional

indeed-apply-coverletter

String. Indicates whether the coverletter field is required.

Valid value is optional, hidden, or required.

Default is optional.

📘 Note:

Cover letters are sent as free-form text. If an attachment is expected, consider using a screener question to request a file upload.

required

indeed-apply-resume

Indicates whether a resume is required, optional, or hidden.

Valid value is optional, hidden, or required. Default is required.

If value is optional or hidden, you must include screener questions as <indeed-apply-questions>.

📘 Note:

You must support .pdf, .doc, .docx, .rtf, and .txt formats for resumes. Candidates can also opt to use their Indeed resume rather than uploading one.

required

indeed-apply-name

String. Indicates whether to split the name field into first and last names or show the name in a single field.

Default is a single field. Indeed recommends that you use name="firstlastname".

firstlastname

indeed-apply-questions

Required if required by the job

URL that returns a JSON-formatted string of questions to be asked during the Indeed Apply application process.

Encode this URL in XML files. Must be HTTPS.

For more information about creating questions, see Add Indeed Apply screener questions.

For an example of a screener question JSON file, click Example Indeed Apply Screener Questions JSON file.

https%3A%2F%2Fwww.yourcompany.com
%2Fjob1234%2Fquestions.json

indeed-apply-email

The employer email used to send the applications. This is an encrypted value. See the Encryption and decryption section for more information.

This field is required if indeed-apply-postUrl is not provided.

📘 Note: This field is NOT permitted for ATS integrations. This field may only be used by direct employer integrations.

b18d0be4c173dfa2b7cb7856e7c7b6f
02a563867a9df67ca208c8b9654966299

indeed-apply-locale

Determines the language used when sending the email to the employer (only applies if indeed-apply-email is used). The default language is English (en).

📘 Note:

This field does not affect the confirmation email sent to the applicant.

es

indeed-apply-advNum

The advertiser number to use when attributing an application conversion.

📘 Note:

This field only applies to Direct Employer integrations.

1432700306306892

XML feed with <indeed-apply-data>

This example XML feed defines one job and the <indeed-apply-data> element:.

📘

Note:

Your XML feed must include the basic job elements, which the example omits for clarity.

<?xml version="1.0" encoding="utf-8"?>
<source>
  <!--publisher is applicable to ATS developers only-->
  <publisher/>
  <!--publisherurl is applicable to ATS developers only-->
  <publisherurl/>
  <job>
    <title/>
    <date/>
    <referencenumber/>
    <requisitionid/>
    <url/>
    <company/>
    <sourcename/>
    <city/>
    <state/>
    <country/>
    <email/>
    <postalcode/>
    <description/>
    <salary/>
    <education/>
    <jobtype/>
    <category/>
    <experience/>
    <indeed-apply-data>
      <![CDATA
      [indeed-apply-apiToken=1234ABCDE&indeed-apply-jobTitle=
      Professional+Basket+Weaver&indeed-apply-jobId=Sample+ID &indeed-apply-jobCompanyName=My+Favorite+Company
      &indeed-apply-jobLocation=Austin+TX&indeed-apply-jobUrl=
      http%3A%2F%2Fwww.indeed.com&indeed-apply-postUrl=
      https%3A%2F%2Fhookb.in%2FPxOjJqJELNH8lZLZDkpz&indeed-apply-questions
      =https%3A%2F%2Fpastebin.com%2Fraw%2F0vXq9q9b%23]]>
    </indeed-apply-data>
  </job>
</source>

Test Indeed Apply metadata

To test the entire Indeed Apply application including the full screener question process, use the Indeed Apply XML configuration testing tool. For more information about the tool, see Test Indeed Apply.