Recruitee

https://docs.recruitee.com/docs
Admin
Recruitee is a recruitment and applicant tracking system that provides webhooks, APIs, and job board...
Tokens:24,332
Snippets:69
Trust Score:10
Update:9 months ago
Show doc for...
Tokens:
Raw
### Example Recruitee Webhook Test Request (HTTP)

Source: https://docs.recruitee.com/docs/index

This is an example of an HTTP POST request sent by Recruitee when a webhook test is initiated. It includes a 'test' parameter to distinguish it from actual event notifications. Your service should be prepared to handle this parameter.

```HTTP
POST /your-path HTTP/1.1
Content-Type: application/json
User-Agent: Recruitee-Webhooks

{"test":true}
```

--------------------------------

### XML Job Feed Example

Source: https://docs.recruitee.com/docs/example-xml-feed

This XML snippet represents a sample job feed for the Recruitee platform. It includes details for multiple job offers, each containing information about the company, job title, description, requirements, location, and other relevant attributes. It also demonstrates multi-language support within the feed structure.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<jobs>
  <job>
    <reference>
      <![CDATA[ offer-uov3p:263372 ]]> 
    </reference>
    <company>
      <![CDATA[ [JB] Deutsches Radio ]]> 
    </company>
    <company_id>
      <![CDATA[ 28878 ]]> 
    </company_id>
    <title>
      <![CDATA[ Redakteur/in und Radio Moderator/in ]]> 
    </title>
    <description_requirements>
      <![CDATA[ <p><br /></p><p>Zur Erweiterung des redaktionellen Angebots und des Programms sucht ein Radiosender aus Berlin neue Mitarbeiter.<br /><br /></p> <p>Es erwartet Euch eine anspruchsvolle, abwechlungsreiche und unkonventionelle Radiotätigkeit sowie bei Bedarf<br />Anleitung und Unterstützung.<br />Alle Mitarbeiterinnen und Mitarbeiter sind komplett ehrenamtlich tätig, das heißt es gibt keine finanzielle Vergütung.<br />Ihr moderiert weitgehend in Eigenregie eine Sendung (oder auch mehrere) und betreut diese Sendung(en) redaktionell.</p> <br /> <p><br /></p><br /><br /><p>Absolvierte Volontariate oder Praktika im Hörfunk sind für eine Mitarbeit nicht zwingend erforderlich.<br />Ideal für Einsteiger, um weitere Erfahrungen zu sammeln!<br />Radio-Leidenschaft und entsprechendes Talent wird vorausgesetzt.<br />Der Radiosender legt allergrößten Wert auf Zuverlässigkeit, Teamfähigkeit, Engagement, und Kreativität! Genau in dieser Reihenfolge., Mindestalter 18 Jahre<br />angenehme Radiostimme<br />nach Möglichkeit Moderationserfahrung sowie redaktionelle und technische Fähigkeiten.<br />Von Vorteil ist eigenes Produktionsequipment.</p> ]]> 
    </description_requirements>
    <locations>
      <location>
        <country>
          <![CDATA[ DE ]]> 
        </country>
        <state>
          <![CDATA[ BE ]]> 
        </state>
        <city>
          <![CDATA[ Berlin ]]> 
        </city>
        <street>
          <![CDATA[ Stille Straße 10 ]]> 
        </street>
        <postal_code>
          <![CDATA[ 13156 ]]> 
        </postal_code>
        <translations>
          <de>
            <city>
              <![CDATA[ Berlin ]]> 
            </city>
            <street>
              <![CDATA[ Stille Straße 10 ]]> 
            </street>
            <postal_code>
              <![CDATA[ 13156 ]]> 
            </postal_code>
          </de>
        </translations>
      </location>
    </locations>
    <city>
      <![CDATA[ Berlin ]]> 
    </city>
    <street>
      <![CDATA[ Stille Straße 10 ]]> 
    </street>
    <state>
      <![CDATA[ BE ]]> 
    </state>
    <country>
      <![CDATA[ DE ]]> 
    </country>
    <postal_code/>
    <hybrid>false</hybrid>
    <on_site>true</on_site>
    <remote>false</remote>
    <education>
      <![CDATA[ high school coursework ]]> 
    </education>
    <experience>
      <![CDATA[ student (college) ]]> 
    </experience>
    <contract_type>
      <![CDATA[ part-time ]]> 
    </contract_type>
    <category>
      <![CDATA[ arts and entertainment ]]> 
    </category>
    <min_hours>
      <![CDATA[ 15 ]]> 
    </min_hours>
    <max_hours>
      <![CDATA[ 20 ]]> 
    </max_hours>
    <salary>
      <min_salary>
        <![CDATA[ 2000 ]]> 
      </min_salary>
      <max_salary>
        <![CDATA[ 2500 ]]> 
      </max_salary>
      <period>
        <![CDATA[ month ]]> 
      </period>
      <currency>
        <![CDATA[ EUR ]]> 
      </currency>
    </salary>
    <url>
      <![CDATA[ https://jbdeutschesradio.s.recruitee.com/o/redakteurin-und-radio-moderatorin?source=WerkZoeken.nl ]]> 
    </url>
    <apply_url>
      <![CDATA[ https://jbdeutschesradio.s.recruitee.com/o/redakteurin-und-radio-moderatorin/c/new?source=WerkZoeken.nl ]]> 
    </apply_url>
    <posted>
      <![CDATA[2023-06-15T12:55:40-00:00]]>
    </posted>
    <updated>
      <![CDATA[2023-06-15T12:57:30-00:00]]>
    </updated>
    <translations>
      <primary_lang_code>
        <![CDATA[ de ]]> 
      </primary_lang_code>
      <title>
        <de>
          <![CDATA[ Redakteur/in und Radio Moderator/in ]]> 
        </de>
      </title>
      <description_requirements>
        <de>
          <![CDATA[ <p><br /></p><p>Zur Erweiterung des redaktionellen Angebots und des Programms sucht ein Radiosender aus Berlin neue Mitarbeiter.<br /><br /></p> <p>Es erwartet Euch eine anspruchsvolle, abwechlungsreiche und unkonventionelle Radiotätigkeit sowie bei Bedarf<br />Anleitung und Unterstützung.<br />Al ]]> 
        </de>
      </description_requirements>
    </translations>
  </job>
</jobs>
```

--------------------------------

### XML Example: Job Board Credentials for Posting Offers

Source: https://docs.recruitee.com/docs/feed

This XML snippet illustrates how job board-specific credentials, such as company IDs and secret tokens, are included in the feed. These credentials are required by certain job boards for the successful posting of job offers.

```xml
<credentials>
	<acme_company_id>
		<![CDATA[ 12323 ]]> 
	</acme_company_id>
	<acme_secret_token>
		<![CDATA[ E6cs5SYwRlCqQUh7pYP1PSU98NETqZDXetVcLVsD44 ]]> 
	</acme_secret_token>
</credentials>
```

--------------------------------

### Example JSON Payload for Candidate Created Event

Source: https://docs.recruitee.com/docs/webhooks

This JSON object represents the data sent when a new candidate is created in Recruitee. It includes event details, candidate information, company context, and any offers assigned to the candidate.

```json
{
  "attempt_count": 1,
  "created_at": "2020-12-11T23:50:56.168592Z",
  "event_subtype": "manual",
  "event_type": "new_candidate",
  "id": 73,
  "payload": {
    "candidate": {
      "created_at": "2020-12-11T23:50:54.110368Z",
      "emails": [
        "john.doe@mail.com"
      ],
      "id": 21056,
      "name": "John Doe",
      "phones": [
        "123123123"
      ],
      "photo_thumb_url": "https://recruitee-dev.s3.eu-central-1.amazonaws.com/candidates/21056/thumb_photo_vweaseucrbtp.png",
      "source": "manual",
      "updated_at": "2020-12-11T23:50:54.110368Z"
    },
    "company": {
      "id": 1,
      "name": "Devtest Company"
    },
    "offers": [
      {
        "created_at": "2018-07-10T10:29:15.000000Z",
        "department": {
          "id": 9,
          "name": "Maritime"
        },
        "id": 617,
        "kind": "job",
        "locations": [
          {
            "country_code": "DE",
            "full_address": "Germany, Saarland, Düsseldorf, 90910, Saarlander Street",
            "id": 8,
            "state_code": "SL"
          },
          {
            "country_code": "PL",
            "full_address": "Poland, Wielkopolskie, Poznań, 61-248, Polish Street",
            "id": 63,
            "state_code": "WP"
          }
        ],
        "slug": "cruiser-captain",
        "tags": [],
        "title": "Cruiser Captain",
        "updated_at": "2020-12-11T23:50:55.835946Z"
      }
    ]
  }
}
```

--------------------------------

### Job Published Webhook Example (JSON)

Source: https://docs.recruitee.com/docs/index

This snippet demonstrates the JSON payload received when a new job is published via Recruitee. It includes details about the company, the offer, and its associated metadata. This event is triggered when a job is set to be publicly visible.

```json
{
  "attempt_count": 1,
  "created_at": "2022-03-03T20:25:33.995135Z",
  "event_subtype": "manual",
  "event_type": "offer_published",
  "id": 75,
  "payload": {
    "company": {
      "id": 1,
      "name": "Devtest Company"
    },
    "offer": {
      "created_at": "2020-10-22T17:45:00Z",
      "department": {
        "id": 123,
        "name": "Marketing"
      },
      "id": 123,
      "kind": "job",
      "locations": [
        {
          "country_code": "DE",
          "full_address": "Germany, Saarland, Düsseldorf, 90910, Saarlander Street",
          "id": 8,
          "state_code": "SL"
        },
        {
          "country_code": "PL",
          "full_address": "Poland, Wielkopolskie, Poznań, 61-248, Polish Street",
          "id": 63,
          "state_code": "WP"
        }
      ],
      "slug": "front-end-web-developer",
      "tags": [
        {
          "id": 123,
          "name": "Important"
        },
        {
          "id": 123,
          "name": "Hiring Forecast Q3"
        }
      ],
      "title": "Front-end Web Developer",
      "updated_at": "2020-10-22T17:45:00Z"
    }
  }
}
```

--------------------------------

### XML Example: Multilingual Job Offer in Recruitee

Source: https://docs.recruitee.com/docs/feed

This XML snippet demonstrates how a job offer can be structured to include translations for its title and description requirements, catering to multiple languages. It includes a primary language code and then language-specific elements for title and description.

```xml
<translations>
  <primary_lang_code><![CDATA[it]]></primary_lang_code>
  <title>
    <en><![CDATA[Pharmacy field service]]></en>
    <it><![CDATA[Servizio esterno di farmacia]]></it>
  </title>
  <description_requirements>
    <en><![CDATA[<p>Description</p><p>Requirements</p>]]></en>
    <it><![CDATA[<p>Descrizione</p><p>Requisiti</p>]]></it>
  </description_requirements>
</translations>
```

--------------------------------

### Handle Candidate Deleted Event (JSON Example)

Source: https://docs.recruitee.com/docs/index

This JSON object represents the payload for a 'candidate_deleted' event. It contains information about the deleted candidate and any associated offers. This event is triggered when a candidate is removed from the system.

```json
{
  "attempt_count": 1,
  "created_at": "2020-12-11T23:50:56.168592Z",
  "event_subtype": "manual",
  "event_type": "candidate_deleted",
  "id": 73,
  "payload": {
    "candidate": {
      "created_at": "2020-12-11T23:50:54.110368Z",
      "emails": [
        "john.doe@mail.com"
      ],
      "id": 21056,
      "name": "John Doe",
      "phones": [
        "123123123"
      ],
      "photo_thumb_url": "https://recruitee-dev.s3.eu-central-1.amazonaws.com/candidates/21056/thumb_photo_vweaseucrbtp.png",
      "source": "manual",
      "updated_at": "2020-12-11T23:50:54.110368Z"
    },
    "company": {
      "id": 1,
      "name": "Devtest Company"
    },
    "offers": [
      {
        "created_at": "2018-07-10T10:29:15.000000Z",
        "department": {
          "id": 9,
          "name": "Maritime"
        },
        "id": 617,
        "kind": "job",
        "locations": [
          {
            "country_code": "DE",
            "full_address": "Germany, Saarland, Düsseldorf, 90910, Saarlander Street",
            "id": 8,
            "state_code": "SL"
          },
          {
            "country_code": "PL",
            "full_address": "Poland, Wielkopolskie, Poznań, 61-248, Polish Street",
            "id": 63,
            "state_code": "WP"
          }
        ],
        "slug": "cruiser-captain",
        "tags": [],
        "title": "Cruiser Captain",
        "updated_at": "2020-12-11T23:50:55.835946Z"
      }
    ]
  }
}
```

--------------------------------

### Handle Candidate Moved Event (JSON Example)

Source: https://docs.recruitee.com/docs/index

This JSON object represents the payload for a 'candidate_moved' event. It includes details about the candidate, company, offer, and the stage change. This event is triggered when a candidate is moved to a different pipeline, disqualified, or requalified.

```json
{
  "attempt_count": 1,
  "created_at": "2020-12-12T00:30:01.860998Z",
  "event_subtype": "stage_changed",
  "event_type": "candidate_moved",
  "id": 75,
  "payload": {
    "candidate": {
      "created_at": "2020-12-11T23:50:54.110368Z",
      "emails": [
        "john.doe@mail.com"
      ],
      "id": 21056,
      "name": "John Doe",
      "phones": [
        "123123123"
      ],
      "photo_thumb_url": "https://recruitee-dev.s3.eu-central-1.amazonaws.com/candidates/21056/thumb_photo_vweaseucrbtp.png",
      "source": "manual",
      "updated_at": "2020-12-11T23:50:54.110368Z"
    },
    "company": {
      "id": 1,
      "name": "Devtest Company"
    },
    "details": {
      "from_stage": {
        "id": 5716,
        "name": "Applied",
        "category": "apply"
      },
      "to_stage": {
        "id": 4110,
        "name": "Phone interview",
        "category": "phone_screen"
      }
    },
    "offer": {
      "created_at": "2018-07-10T10:29:15.000000Z",
      "department": {
        "id": 9,
        "name": "Maritime"
      },
      "id": 617,
      "kind": "job",
      "locations": [
        {
          "country_code": "DE",
          "full_address": "Germany, Saarland, Düsseldorf, 90910, Saarlander Street",
          "id": 8,
          "state_code": "SL"
        },
        {
          "country_code": "PL",
          "full_address": "Poland, Wielkopolskie, Poznań, 61-248, Polish Street",
          "id": 63,
          "state_code": "WP"
        }
      ],
      "slug": "cruiser-captain",
      "tags": [],
      "title": "Cruiser Captain",
      "updated_at": "2020-12-11T23:50:55.835946Z"
    },
    "placement_locations": [
      {
        "country_code": "DE",
        "full_address": "Germany, Saarland, Düsseldorf, 90910, Saarlander Street",
        "id": 8,
        "state_code": "SL"
      }
    ]
  }
}
```

--------------------------------

### Job Updated Webhook Example (JSON)

Source: https://docs.recruitee.com/docs/index

This JSON payload indicates that a job posting has been modified in Recruitee. The `event_subtype` can specify the type of change, such as 'offer_changed', 'status_changed', or 'tags_changed'. It includes the updated details of the offer.

```json
{
  "attempt_count": 1,
  "created_at": "2023-02-24T12:13:05.293345Z",
  "event_subtype": "offer_changed",
  "event_type": "offer_updated",
  "id": 77,
  "payload": {
    "company": {
      "id": 1,
      "name": "Devtest Company"
    },
    "offer": {
      "created_at": "2022-04-19T10:28:01.492893Z",
      "department": {
        "id": 123,
        "name": "Marketing"
      },
      "id": 123,
      "kind": "job",
      "locations": [
        {
          "country_code": "DE",
          "full_address": "Germany, Saarland, Düsseldorf, 90910, Saarlander Street",
          "id": 8,
          "state_code": "SL"
        },
        {
          "country_code": "PL",
          "full_address": "Poland, Wielkopolskie, Poznań, 61-248, Polish Street",
          "id": 63,
          "state_code": "WP"
        }
      ],
      "slug": "hr-manager",
      "status": "published",
      "tags": [
        {
          "id": 123,
          "name": "Important"
        }
      ],
      "title": "HR Manager",
      "updated_at": "2023-02-24T12:13:05.205048Z"
    }
  }
}
```

--------------------------------

### Example JSON Payload for Candidate Assigned Webhook

Source: https://docs.recruitee.com/docs/webhooks

This JSON object represents the data payload received when a candidate is assigned to a job or talent pool via the Recruitee API. It includes details about the event, the assigned candidate, the associated company, the offer, and placement locations. This structure is consistent across all Recruitee integrations using this webhook.

```json
{
  "attempt_count": 1,
  "created_at": "2020-12-11T23:50:56.233856Z",
  "event_subtype": "manual",
  "event_type": "candidate_assigned",
  "id": 74,
  "payload": {
    "candidate": {
      "created_at": "2020-12-11T23:50:54.110368Z",
      "emails": [
        "john.doe@mail.com"
      ],
      "id": 21056,
      "name": "John Doe",
      "phones": [
        "123123123"
      ],
      "photo_thumb_url": "https://recruitee-dev.s3.eu-central-1.amazonaws.com/candidates/21056/thumb_photo_vweaseucrbtp.png",
      "source": "manual",
      "updated_at": "2020-12-11T23:50:54.110368Z"
    },
    "company": {
      "id": 1,
      "name": "Devtest Company"
    },
    "offer": {
      "created_at": "2018-07-10T10:29:15.000000Z",
      "department": {
        "id": 9,
        "name": "Maritime"
      },
      "id": 617,
      "kind": "job",
      "locations": [
        {
          "country_code": "DE",
          "full_address": "Germany, Saarland, Düsseldorf, 90910, Saarlander Street",
          "id": 8,
          "state_code": "SL"
        },
        {
          "country_code": "PL",
          "full_address": "Poland, Wielkopolskie, Poznań, 61-248, Polish Street",
          "id": 63,
          "state_code": "WP"
        }
      ],
      "slug": "cruiser-captain",
      "tags": [],
      "title": "Cruiser Captain",
      "updated_at": "2020-12-11T23:50:55.835946Z"
    },
    "placement_locations": [
      {
        "country_code": "DE",
        "full_address": "Germany, Saarland, Düsseldorf, 90910, Saarlander Street",
        "id": 8,
        "state_code": "SL"
      }
    ]
  }
}
```

--------------------------------

### Job Unpublished Webhook Example (JSON)

Source: https://docs.recruitee.com/docs/index

This JSON payload is sent when a job posting is unpublished or archived in Recruitee. It mirrors the structure of the 'published' event but indicates the offer is no longer active. This is useful for updating external systems when job availability changes.

```json
{
  "attempt_count": 1,
  "created_at": "2022-03-03T20:25:33.995135Z",
  "event_subtype": "manual",
  "event_type": "offer_unpublished",
  "id": 76,
  "payload": {
    "company": {
      "id": 1,
      "name": "Devtest Company"
    },
    "offer": {
      "created_at": "2020-10-22T17:45:00Z",
      "department": {
        "id": 123,
        "name": "Marketing"
      },
      "id": 123,
      "kind": "job",
      "locations": [
        {
          "country_code": "DE",
          "full_address": "Germany, Saarland, Düsseldorf, 90910, Saarlander Street",
          "id": 8,
          "state_code": "SL"
        },
        {
          "country_code": "PL",
          "full_address": "Poland, Wielkopolskie, Poznań, 61-248, Polish Street",
          "id": 63,
          "state_code": "WP"
        }
      ],
      "slug": "front-end-web-developer",
      "tags": [
        {
          "id": 123,
          "name": "Important"
        },
        {
          "id": 123,
          "name": "Hiring Forecast Q3"
        }
      ],
      "title": "Front-end Web Developer",
      "updated_at": "2020-10-22T17:45:00Z"
    }
  }
}
```

--------------------------------

### Webhook Configuration and Usage

Source: https://docs.recruitee.com/docs/index

This section details how to set up and use webhooks in Recruitee. It covers the configuration process, including setting the POST URL, selecting events, and testing the webhook. It also explains how Recruitee sends POST requests for events and test notifications.

```APIDOC
## POST /your-path (Webhook Notification)

### Description
Receives real-time event notifications from Recruitee via HTTP POST requests.

### Method
POST

### Endpoint
`/your-path` (This is the POST URL configured in Recruitee settings)

### Parameters
#### Request Body
- **test** (boolean) - Optional - Included in test requests to identify them as not real events.
- **event_data** (object) - Contains details of the event that occurred in Recruitee.

### Request Example (Test Request)
```json
{
  "test": true
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates successful receipt of the webhook.

#### Response Example (Success)
```json
{
  "status": "success"
}
```

#### Error Response
Any status code other than `200` is considered a delivery failure.
```

--------------------------------

### Webhook Configuration

Source: https://docs.recruitee.com/docs/webhooks

This section details how to configure new webhooks in Recruitee, including setting the name, POST URL, selecting events, and testing the configuration.

```APIDOC
## POST /webhooks

### Description
Configure a new webhook to receive event notifications from Recruitee. You need to have the 'Manage webhooks' ability assigned to your role.

### Method
POST

### Endpoint
/settings/webhooks/overview

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **Name** (string) - Required - A meaningful name for the webhook.
- **POST URL** (string) - Required - The HTTPS endpoint where Recruitee should send notifications.
- **Events** (array of strings) - Optional - A list of events to subscribe to. If not selected, you can adjust later.

### Request Example
```json
{
  "Name": "My Application",
  "POST URL": "https://myapp.com/webhook-listener",
  "Events": ["candidate.created", "job.updated"]
}
```

### Response
#### Success Response (200)
- **Webhook Configuration Details** (object) - Confirmation of the webhook setup.

#### Response Example
```json
{
  "message": "Webhook configured successfully.",
  "webhookId": "wh_12345abcde"
}
```
```

--------------------------------

### Candidate Created Webhook

Source: https://docs.recruitee.com/docs/index

This webhook is triggered when a new candidate applies or is created within Recruitee. It includes details about the candidate, company, and any associated offers.

```APIDOC
## POST /webhooks/recruitee

### Description
This endpoint receives webhook notifications from Recruitee when a new candidate is created or applies.

### Method
POST

### Endpoint
`/webhooks/recruitee`

### Request Body
#### Fields
- **event_type** (string) - Required - Always equals "new_candidate".
- **event_subtype** (string) - Required - Indicates how the candidate was created (e.g., "email", "career_site", "manual", "imported").
- **payload** (object) - Required - Contains the event data.
  - **payload.candidate** (object) - Required - Information about the newly created candidate.
    - **payload.candidate.created_at** (string) - Timestamp of candidate creation.
    - **payload.candidate.emails** (array of strings) - List of candidate email addresses.
    - **payload.candidate.id** (integer) - Unique identifier for the candidate.
    - **payload.candidate.name** (string) - Full name of the candidate.
    - **payload.candidate.phones** (array of strings) - List of candidate phone numbers.
    - **payload.candidate.photo_thumb_url** (string) - URL for the candidate's thumbnail photo.
    - **payload.candidate.source** (string) - Source of the candidate (e.g., "manual").
    - **payload.candidate.updated_at** (string) - Timestamp of the last candidate update.
  - **payload.company** (object) - Required - Information about the company.
    - **payload.company.id** (integer) - Unique identifier for the company.
    - **payload.company.name** (string) - Name of the company.
  - **payload.offers** (array of objects) - Optional - Offers the candidate was assigned to upon creation.
    - **payload.offers[].created_at** (string) - Timestamp of offer creation.
    - **payload.offers[].department** (object) - Department associated with the offer.
      - **payload.offers[].department.id** (integer) - Department ID.
      - **payload.offers[].department.name** (string) - Department name.
    - **payload.offers[].id** (integer) - Unique identifier for the offer.
    - **payload.offers[].kind** (string) - Type of offer (e.g., "job").
    - **payload.offers[].locations** (array of objects) - Locations associated with the offer.
      - **payload.offers[].locations[].country_code** (string) - Country code.
      - **payload.offers[].locations[].full_address** (string) - Full address.
      - **payload.offers[].locations[].id** (integer) - Location ID.
      - **payload.offers[].locations[].state_code** (string) - State code.
    - **payload.offers[].slug** (string) - Offer slug.
    - **payload.offers[].tags** (array) - Tags associated with the offer.
    - **payload.offers[].title** (string) - Title of the offer.
    - **payload.offers[].updated_at** (string) - Timestamp of the last offer update.

### Request Example
```json
{
  "attempt_count": 1,
  "created_at": "2020-12-11T23:50:56.168592Z",
  "event_subtype": "manual",
  "event_type": "new_candidate",
  "id": 73,
  "payload": {
    "candidate": {
      "created_at": "2020-12-11T23:50:54.110368Z",
      "emails": [
        "john.doe@mail.com"
      ],
      "id": 21056,
      "name": "John Doe",
      "phones": [
        "123123123"
      ],
      "photo_thumb_url": "https://recruitee-dev.s3.eu-central-1.amazonaws.com/candidates/21056/thumb_photo_vweaseucrbtp.png",
      "source": "manual",
      "updated_at": "2020-12-11T23:50:54.110368Z"
    },
    "company": {
      "id": 1,
      "name": "Devtest Company"
    },
    "offers": [
      {
        "created_at": "2018-07-10T10:29:15.000000Z",
        "department": {
          "id": 9,
          "name": "Maritime"
        },
        "id": 617,
        "kind": "job",
        "locations": [
          {
            "country_code": "DE",
            "full_address": "Germany, Saarland, Düsseldorf, 90910, Saarlander Street",
            "id": 8,
            "state_code": "SL"
          },
          {
            "country_code": "PL",
            "full_address": "Poland, Wielkopolskie, Poznań, 61-248, Polish Street",
            "id": 63,
            "state_code": "WP"
          }
        ],
        "slug": "cruiser-captain",
        "tags": [],
        "title": "Cruiser Captain",
        "updated_at": "2020-12-11T23:50:55.835946Z"
      }
    ]
  }
}
```

### Response
#### Success Response (200)
An empty JSON object `{}` is returned upon successful receipt of the webhook.

#### Response Example
```json
{}
```
```

--------------------------------

### Verify Recruitee Webhook Signature (Shell)

Source: https://docs.recruitee.com/docs/index

This snippet demonstrates how to verify a Recruitee webhook signature using shell commands. It involves setting the webhook secret and request body as environment variables, then calculating the HMAC-SHA256 hash and comparing it to the 'X-Recruitee-Signature' header. This method helps confirm the webhook's origin and that the body has not been tampered with.

```shell
$ SECRET='DuP4ej5yyJB5TIrIEI/dCtJN7sHj'

$BODY='{"attempt_count":1,"created_at":"2020-12-14T04:47:33.905241Z","event_subtype":"stage_changed","event_type":"candidate_moved","id":30,"payload":{"candidate":{"created_at":"2020-12-09T14:36:56.578000Z","emails":[],"id":975539,"name":"test","phones":[],"photo_thumb_url":"https://recruitee-staging.s3.eu-central-1.amazonaws.com/candidates/975539/thumb_photo_anydaa715ph6.png","referrer":null,"source":"manual","updated_at":"2020-12-09T14:37:01.119831Z"},"company":{"id":5943,"name":"MP company 2"},"details":{"from_stage":{"id":911876,"name":"Phone interview"},"to_stage":{"id":911877,"name":"On-site interview"}},"offer":{"created_at":"2020-12-09T14:37:59.875608Z","department":null,"id":269122,"kind":"job","slug":"test-job","tags":[],"title":"test job","updated_at":"2020-12-09T14:38:17.539041Z"}}}'

$ echo -n $BODY | openssl dgst -sha256 -hmac $SECRET
3b64e3049cb9e108fbb18a453e909cb4a32e3ae140ea01d84c2b5d316c19162f
```

--------------------------------

### Webhook Delivery Guarantees

Source: https://docs.recruitee.com/docs/webhooks

Explanation of Recruitee's retry mechanism for failed webhook deliveries and timeout settings.

```APIDOC
## Webhook Delivery Retries

### Description
Recruitee implements a retry strategy for webhook deliveries that fail (i.e., do not receive a `200` HTTP status code). The retries are progressively delayed up to nine attempts.

### Retry Schedule
1.  After 1 minute
2.  3 minutes after the 1st failure
3.  10 minutes after the 2nd failure
4.  45 minutes after the 3rd failure
5.  2 hours after the 4th failure
6.  5 hours after the 5th failure
7.  10 hours after the 6th failure
8.  24 hours after the 7th failure
9.  48 hours after the 8th failure

### Timeout
Requests will timeout after **10 seconds**. Ensure your service responds within this timeframe.

### Error Handling
Any response status code other than `200` is considered a delivery failure.
```

--------------------------------

### Candidate Moved Event Details

Source: https://docs.recruitee.com/docs/index

Provides details about candidate movement events within the pipeline, with variations based on the event subtype.

```APIDOC
## CandidateMovedDetails

### Description
The contents of `payload.details` in the "Pipeline change" event depend on `event_subtype`. There are three options.

### Event Subtypes

1.  **`event_subtype` is "stage_changed":**

    #### Fields
    *   **from_stage** (Stage) - Candidate's previous stage in the pipeline.
    *   **to_stage** (Stage) - Candidate's new stage in the pipeline.

2.  **`event_subtype` is "disqualified":**

    #### Fields
    *   **to_stage** (Stage) - The stage candidate was disqualified in.
    *   **disqualify_reason** (DisqualifyReason) - Reason for candidate's disqualification.

3.  **`event_subtype` is "requalified":**

    #### Fields
    *   **to_stage** (Stage) - The stage candidate was brought back to.
```

--------------------------------

### Webhook Request Log and Delivery Guarantees

Source: https://docs.recruitee.com/docs/index

Information on accessing the request log for webhooks and understanding Recruitee's delivery guarantees, including retry mechanisms and timeouts.

```APIDOC
## Webhook Delivery Guarantees

### Description
Details on how Recruitee handles webhook delivery failures, including retry attempts and timeouts.

### Delivery Guarantees
- Recruitee will retry delivery up to nine times for any response status other than `200`.
- Retry intervals increase with each attempt: 1 min, 3 min, 10 min, 45 min, 2 hours, 5 hours, 10 hours, 24 hours, 48 hours.
- Requests will timeout after 10 seconds. Ensure your service responds within this timeframe.

### Request Log
- Webhook requests are logged for 30 days.
- Access logs under Settings > Apps and Plugins > Webhooks > Logs tab.
- Logs show request body, response, retry details, and options to cancel retries or retry immediately.
```

--------------------------------

### Entity Structures

Source: https://docs.recruitee.com/docs/index

Defines common entity structures used within the Recruitee API, including SimpleEntity, Stage, and Location.

```APIDOC
## SimpleEntity

### Description
Includes `Company`, `Tag`, `Department`, `DisqualifyReason`.

### Fields
*   **id** (integer) - Entity's ID.
*   **name** (string) - Entity's name.

---

## Stage

### Description
Represents a stage in the candidate pipeline.

### Fields
*   **id** (integer) - Stage's ID.
*   **name** (string) - Stage's name.
*   **category** (string) - Stage's category. Can be one of "none", "apply", "phone_screen", "interview", "evaluation", "offer", "hire".

---

## Location

### Description
Represents a location associated with a candidate's assignment or offer.

### Fields
*   **id** (integer) - Location's ID.
*   **country_code** (string) - Location's ISO 3166 country code.
*   **state_code** (string) - Location's ISO 3166 state code.
*   **full_address** (string) - Concatenated values of location's country name, state, city, postal code and street.
```

--------------------------------

### Testing Webhooks

Source: https://docs.recruitee.com/docs/webhooks

Details on how to test your configured webhook endpoint using the 'Test' button or 'Test payload' buttons, including the format of the test request.

```APIDOC
## POST /your-path (Test Request)

### Description
When you click the 'Test' or 'Test payload' button in the Recruitee webhook configuration, Recruitee sends a POST request to your specified URL to verify the endpoint.

### Method
POST

### Endpoint
Your configured POST URL (e.g., /your-path)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **test** (boolean) - Required - Included in test requests to identify them as tests. Value is `true`.
- **(Optional)** Example event payload fields are included when using 'Test payload' buttons.

### Request Example
```http
POST /your-path HTTP/1.1
Content-Type: application/json
User-Agent: Recruitee-Webhooks

{
  "test": true
}
```

### Response
#### Success Response (200)
Your service must respond with an HTTP `200` status code to successfully verify and create the webhook configuration. Failure to do so will result in the webhook not being created.

#### Response Example
```json
{
  "status": "success"
}
```
```

--------------------------------

### Stage API

Source: https://docs.recruitee.com/docs/webhooks

Information about the structure and fields for a Stage object in Recruitee.

```APIDOC
## Stage Object

### Description
Represents a stage in a recruitment pipeline.

### Fields
#### id (integer)
- Description: Stage's ID.

#### name (string)
- Description: Stage's name.

#### category (string)
- Description: Stage's category. Can be one of "none", "apply", "phone_screen", "interview", "evaluation", "offer", "hire".
```

--------------------------------

### Job Details Options

Source: https://docs.recruitee.com/docs/feed

Provides possible values for job-related fields like education, experience, and contract type.

```APIDOC
## Job Details Options

### Description
This section lists the predefined options available for various job attributes.

### Education
- high school coursework
- high school or equivalent
- certification
- vocational
- college coursework completed
- associate degree
- bachelor's degree
- master's degree
- doctorate
- professional

### Experience
- student (high school)
- student (college)
- entry level
- mid level
- experienced
- manager
- senior manager / supervisor
- executive
- senior executive

### Contract Type
- full-time
- full-time permanent
- full-time fixed-term
- part-time
- part-time permanent
- part-time fixed-term
- part-time minijob
- temporary
- contract
- freelance
- internship
- apprenticeship
- seasonal
- volunteer
```

--------------------------------

### Webhook Rate Limiting

Source: https://docs.recruitee.com/docs/index

Information regarding the rate limits for sending webhooks from Recruitee.

```APIDOC
## Webhook Rate Limiting

### Description
Details on the rate limits imposed on webhook requests sent by Recruitee.

### Rate Limits
- **Trial companies:** Limited to 5 requests per minute.
- **All other companies:** Quota of 100 requests per minute.
- **Exceeding limits:** Subsequent webhook requests will be delayed by 10 +/- 5 minutes.
```
Tokens:
Raw