POST v1/gethired/notify/applicant

Provides a notification web hook for GetHired to notify the system that an applicant has reached a given step.

Request Information

URI Parameters

None.

Body Parameters

The notification data

Name	Type	Additional information
applicant_id	string	None.
job_id	string	None.
workflow_step_id	string	None.
company_id	string	None.
api_key	string	None.
assertion_id	string	None.
nonce	string	None.
timestamp	string	None.
signature	string	None.

Request Formats

application/json, text/json

Sample:

{
  "applicant_id": "sample string 1",
  "job_id": "sample string 2",
  "workflow_step_id": "sample string 3",
  "company_id": "sample string 4",
  "api_key": "sample string 5",
  "assertion_id": "sample string 6",
  "nonce": "sample string 7",
  "timestamp": "sample string 8",
  "signature": "sample string 9"
}

text/xml

Sample:

<NotifyApplicantModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Web.Models.External.GetHired">
  <api_key>sample string 5</api_key>
  <assertion_id>sample string 6</assertion_id>
  <nonce>sample string 7</nonce>
  <signature>sample string 9</signature>
  <timestamp>sample string 8</timestamp>
  <company_id>sample string 4</company_id>
  <applicant_id>sample string 1</applicant_id>
  <job_id>sample string 2</job_id>
  <workflow_step_id>sample string 3</workflow_step_id>
</NotifyApplicantModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A response indicated whether the notification succeeded.

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.