Enable web interviews

Enable employers on your ATS site to view, create, and edit interview schedules with applicants of their jobs.

 

Deprecation notice

This feature is deprecated.

The interview feature of the ATS JavaScript Plugin enables employers on your ATS site to view, create, and edit interview schedules with applicants of their jobs.

Enable interviews in the plugin

In the <script> tag for the ATS JavaScript Plugin, include interview in the data-indeed-enabled-plugins attribute. See Load the plugin script.

Display an interview button

After you enable interviews, the Web Interview button is available to add to your ATS site. This button enables employers to view existing web interviews and schedule new web interviews.

To display an interview button, add the following <div> element:

<div data-indeed-plugin="interview"
    data-indeed-agg-ats-key="<AGGREGATION-ATS-KEY>"
    data-indeed-application-id="<APPLICATION-ID>"
    data-indeed-applicant-name="<APPLICANT-NAME>"
    data-indeed-applicant-email="<APPLICANT-EMAIL>"
    data-indeed-job-title="<JOB-TITLE>">
</div>

Replace the parameters in angle brackets (<>) with your own values. All parameters are required.

The following table describes each data-indeed-* attribute:

Attribute	Required / Optional	Description
data-indeed-plugin	Required	Set to interview so the plugin can display the interview button.
data-indeed-agg-ats-key	Required	The Indeed account's Aggregation ATS key. For more information, see Overview - Set up your Indeed account.
data-indeed-application-id	Required	A unique string identifying the application. The ATS creates this string, which must be UTF-8 and contain only alphanumeric characters, hyphens (-), and underscores (_). Indeed uses the ATS ID and application ID to identify an application.
data-indeed-applicant-name	Required	The applicant's name. Must be a UTF-8 string with a maximum size of 3 bytes. If this string is missing, you cannot create new interviews; however, employers can still view interviews that have already been created.
data-indeed-applicant-email	Required	The applicant's email address that receives interview requests. Must be a valid email address. If this string is missing, you cannot create new interviews; however, employers can still view interviews that have already been created.
data-indeed-job-title	Required	The title of the posted job. Must be a UTF-8 string with a maximum size of 3 bytes. If this string is missing, you cannot create new interviews; however, employers can still view interviews that have already been created.

Button variants

After you embed the HTML code in Display an interview button into your ATS site, the plugin displays the interview button with its predefined styles.

The button is displayed differently depending on its current state:

Where to display interview buttons

To determine where to display interview buttons, consider the context in which employers are likely to schedule interviews.

Also consider the balance of UI elements so that the buttons don't complicate the page.

Here are some recommended places to display interview buttons:

Candidate list page

To enable employers to manage interviews for all candidates, show interview buttons on the candidate list page.

Candidate detail page

To enable employers to manage interviews for a particular candidate, show an interview button on the candidate detail page.

Consider displaying the button close to related information so employers can see it in the right context.

Best practices

Follow these guidelines when displaying interview buttons:

Best practice	✅ Good example	❌ Bad example
The button is automatically rendered with predefined styles following Indeed branding. Use the generated button without making any changes.
The button has a height of 40px and multiple widths depending on its state. Ensure that the site layout is flexible enough to adapt to the button's different states.
The button works best on a light background.
Always maintain a minimum 8px margin on all sides of the button.