Mark as Hired Integration

An applicant in the ATS can be Marked as Hired by two methods.

A Hiring Manager can click the Mark as Hired button in the applicant's profile to mark an applicant as hired and trigger any configured integrations.

Alternatively, the applicant can be sent an offer letter to sign. If the enable_auto_hire setting is enabled, the applicant will be immediately marked as hired upon signing the offer.

Custom Fields

Custom Fields can be assigned to the applicant during the Mark as Hired process from the Hiring Manager, either while creating an Offer Letter or clicking the Mark as Hired button directly.

Add "mark_as_hired" to the ui_render_targets property of a custom field, and it will render in both the Offer Letter Wizard and the Mark as Hired dialog.

Setting the field as required will require the Hiring Manager to complete the field before continuing.

See our Custom Fields guide for more information.

// PUT https://api.applicant-tracking.com/api/v1/companies/:company_id/applications/custom_fields_schema
{
  "custom_fields_schema": [
    {
      "field_name": "favorite_candy",
      "field_type": "string",
      "display_name": "Favorite Candy",
      "default_value": null,
      "required": true,
      "whitelist_values": [],
      "blacklist_values": [],
      "ui_priority": 1,
      "ui_readonly": false,
      "ui_input_type": "text_field",
      "ui_hints": [],
      "ui_render_targets": ["mark_as_hired"]
    }
  ]
}

Mark as Hired webhooks

When a Mark as Hired event occurs, the applicant_marked_as_hired webhook will be delivered to any configured endpoints.

The payload will include the relevant applicant data, along with any custom fields collected during the Mark as Hired process.

{
  "event_name": "applicant_marked_as_hired",
  "application": {
    "id": "1",
    "company_id": "1",
    "company_external_id": "foo",
    "site_id": null,
    "site_external_id": null,
    "first_name": "Example",
    "last_name": "Applicant",
    "gender": null,
    "phone": "+1 (555) 555 5555",
    "email": "[email protected]",
    "address": null,
    "address_2": null,
    "city": null,
    "state": null,
    "zipcode": null,
    "job_title": "Mechanic",
    "job_id": "1",
    "status": null,
    "source": "Example",
    "contact_preference": "email",
    "rating": null,
    "tags": [],
    "applied_at": "2019-10-09T18:47:42-08:00",
    "hired_at": "2021-03-04T00:00:00-09:00",
    "start_date": "2021-03-18",
    "created_at": "2019-10-09T18:47:42-08:00",
    "updated_at": "2021-03-04T10:11:06-09:00",
    "archived_at": null,
    "favorite_candy": "Chocolate"
  }
}

Register a new webhook by POSTing to https://api.applicant-tracking.com/api/v1/webhooks

// POST https://api.applicant-tracking.com/api/v1/webhooks
{
  "event_type": "applicant_marked_as_hired",
  "url": "https://example.org/events/applicant_marked_as_hired"
}

You may also be interested in subscribing to the following events related to hired applicants:

  • applicant_hired_file_added
  • applicant_hired_updated
  • applicant_unmarked_as_hired

See our Using Webhooks guide for more information.


What’s Next