API Reference
Subscribe to UpdatesHelp CenterComeet

Employee Portal – Overview

Build an internal careers site that promotes referrals and internal mobility

An internal careers website for employees helps promote referrals and internal mobility by providing employees with exclusive job opportunities that are not published to the public, as well as tailored content for them.

This article will guide you through the process of building an internal careers website for employees.

Prerequisites

  1. Access to the Recruiting API is available to Comeet customers on the Enterprise plan.
  2. Ask your Dedicated Custom Success Manager to create a dedicated app for you for creating your employee portal. This app will be different from Recruiting API apps that are used for other purposes. The DCSM will provide you with the API Key and Secret to your app.

1. Set up your Comeet account

To get started, create custom position fields that will allow recruiters to define the configuration options for each position. These can include: an option to publish a position to employees, a custom job description for employees and more.

To manage your custom position fields navigate to Settings > Position Fields (requires an Admin or Owner role). Fields added on this settings page will be available for all positions in Comeet.

Here are a few examples of configuration options you may want to add:

An option to publish on employee portal

  1. add a Category field.
  2. Name it "Employee portal: Publish" and select "Internal use".
  3. Select type Dropdown, and include options: "Published" and "Unpublished".
  4. Select Add to save.

An option to have an alternative (or an additional) job description for employees

  1. add a Details field.
  2. Name it "Employee portal: Job description" and select "Internal use".
  3. Select Add to save.

2. Create the position pages

Next, create the position pages on your employee portal. You will need to sync the position data from Comeet to your website and filter the list to only include positions that should be displayed to employees. This process must be created in the backend to keep the Secret and the data secure.

  1. Sync position data
    1. Pull the position data from Comeet using the List All Positions endpoint.
    2. Subscribe to the Positions Updates Webhook to receive near realtime updates to position data.
  2. Filter positions
    1. Filter the list of positions based on the dedicated custom position field that you added to only include the positions that should be displayed to employees. For example, you may want to only display positions where the field “Employee portal: Publish” has the value of “Published”. You will find this data in thecategories array, see the position object for reference.

3. Add the application form

Now that the position pages are ready, you’d like to allow employees to apply for jobs. You can either use Comeet’s application form widget or build your own form and submit the data via the API. Please review the implementation type, customization options and instructions to select the option that is right for your needs and resources.

Option 1: Application form widget

  • Implementation type: Use existing code snippets
  • Customization options: Customize with custom CSS and supported configuration options

Instructions:

  1. Include the Careers API snippet in the <HEAD> of the page.
  2. Add the code snippet of the Application form widget in the position page, where the application form would be rendered.
  3. Leverage the configuration parameters to customize the form.
  4. Define the is-employee parameter to true and add the employee details if known by following these guidelines. If the employee details are not provided then Comeet will ask the employee to enter their name and email.

Option 2: Custom form

  • Implementation type: Custom code
  • Customization options: No limits

Instructions:

  1. Build your own custom form.
  2. When employees apply, submit the candidate details using the Create a candidate endpoint. When submitting new applications from the employee portal the source contact object must be included, follow these guidelines according to the type of application:
    1. Submitting an employee’s application - use the same name and email for the details of the candidate and the source contact. Comeet will identify that these details are identical and the newly created candidate will be attributed to the source "Employees” with the source type of “Internal mobility”.
    2. Submitting referrals - include the details of the employee who referred the candidate in the source contact object. If a source doesn’t already exist for the employee’s email address, it will be created with source type of “Referrer – compensated”. The source type can be changed in Comeet when needed.