Greenhouse

The Greenhouse modules allow you to monitor, create, update, and retrieve the applications, candidates, jobs, job posts, offers, and prospects in your Greenhouse account.

Getting Started with Greenhouse

Prerequisites

Note

The module dialog fields that are displayed in bold (in the Make scenario, not in this documentation article) are mandatory!

Connecting Greenhouse to Make

To connect your Greenhouse account to Make you need to obtain the API Key from your Greenhouse account and insert it in the Create a connection dialog in the Make module.

  1. Log in to your Greenhouse account.

  2. Click Settings > Dev Center > API Credential Management.

    6213a1312ac52.gif
  3. Click Create New API Key.

    6213a134b9ed9.png
  4. Enter the details as follows and click Manage Permissions.

    6213a1360ae81.png

    API Type

    Select or map the API type as Harvest.

    Partner (if applicable)

    (Optional) Select or map the partner applicable for the API type.

    Description

    Enter (map) the details of the API key.

  5. Copy the API key to your clipboard or store the API key in a safe place.

    6213a13738d6f.png

    Select the permissions for the API key once you close this window.

  6. Go to Make and open the Greenhouse module's Create a connection dialog.

    6213a1387616a.gif
  7. Enter the details as follows:

    Connection name

    Enter a name for the connection.

    API Key

    Enter the API key copied in step 5.

  8. Click Continue.

The connection has been established.

Application

Triggers when an application is created, updated, deleted, or approved.

Note

See the Setting Up Greenhouse Webhooks section to add the webhook to your Greenhouse account.

Webhook Name

Enter (map) a name for the webhook.

Connection

Establish a connection to your Greenhouse account.

Event

Select or map the events you want to watch. For example, the application created.

Secret Key

Enter the secret key for the webhook. You can find the key at Settings > Dev Center > Web Hooks.

6213a13aaeec8.png

Lists applications and filters by criteria.

Connection

Establish a connection to your Greenhouse account.

Status

Select or map the status of the application you want to search:

  • Active

  • Converted

  • Hired

  • Rejected

Job ID

Enter (map) or search the Job ID whose applications you want to search.

Created Before

Enter (map) the date to search the application created on or before the specified date.

Created After

Enter (map) the date to search the application created on or after the specified date.

Last Activity After

Enter (map) the date to search the applications whose last activity is on or after the specified date.

Limit

Set the maximum number of applications Make should return during one execution cycle.

Creates a new application for a prospect by their ID.

Connection

Establish a connection to your Greenhouse account.

On behalf of User ID

Enter (map) or search the User ID that is adding the applications to the prospect.

Prospect ID

Enter (map) the Prospect ID to whom you are adding the job applications.

Job IDs

Add the Job IDs whose applications you want to add to the prospect profile.

Source ID

Select or map the Source ID of the application.

Referrer

Add the referrer details:

Type

Select or map the referrer type:

  • Email

  • ID

  • Outside

Email

Enter (map) the referrer's email address.

ID

Select or map the referrer ID.

Outside

Enter (map) the details of the external referrer details.

Prospect Pool ID

Select or map the applicable Pool ID. For example, Talent Community.

Prospect Pool Stage ID

Select or map the applicable pool Stage ID. For example, In Discussion.

Prospect Owner ID

Select or map the assigned Owner ID for the prospect.

Prospect Department ID

Select or map the applicable Department ID for the prospect application.

Custom Fields

Add the custom fields for the prospect:

Country

Select or map the country of the prospect.

Creates a new application for a candidate by their ID.

Connection

Establish a connection to your Greenhouse account.

On behalf of User ID

Enter (map) or search the User ID that is adding the applications to the candidate.

Candidate ID

Enter (map) the Candidate ID to whom you are adding the job applications.

Job IDs

Add the Job IDs whose applications you want to add to the prospect profile.

Source ID

Select or map the Source ID of the application.

Referrer

Add the referrer details:

Type

Select or map the referrer type:

  • Email

  • ID

  • Outside

Email

Enter (map) the referrer's email address.

User ID

Select or map the referrer ID.

Outside

Enter (map) the details of the external referrer details.

Attachments

Add the attachments to the application:

Type

Select or map the attachment type:

  • Resume

  • Cover Letter

  • Other

  • Take-Home Test

  • Offer Letter

  • Signed Offer Letter

Upload By

Select (map) the upload format:

  • URL

  • File

File Name

Enter (map) the file name you want to attach.

URL

Enter (map) the URL address of the attachment. You cannot add shareable links from cloud services such as Google Drive will result in a corrupted file. Please use machine accessible URLs.

Content Type

Enter (map) the content type of the attachment.

Custom Fields

Add the custom fields for the candidate:

Country

Select or map the country of the candidate.

Uploads an attachment to an application by its ID.

Connection

Establish a connection to your Greenhouse account.

On behalf of User ID

Enter (map) or search the User ID to whose application you want to add the attachment.

Application ID

Enter (map) the Application ID to which you want to add the attachment.

Type

Select or map the attachment type:

  • Resume

  • Cover Letter

  • Other

  • Take-Home Test

  • Offer Letter

  • Signed Offer Letter

Upload By

Select (map) the upload format:

  • URL

  • File

File Name

Enter (map) the file name you want to attach.

URL

Enter (map) the URL address of the attachment. You cannot add shareable links from cloud services such as Google Drive will result in a corrupted file. Please use machine accessbile URLs.

Content Type

Enter (map) the content type of the attachment.

Candidate

Triggers when a candidate or prospect is created, updated, deleted, submitted an application, or another status is changed.

Note

See the Setting Up Greenhouse Webhooks section to add the webhook to your Greenhouse account.

Webhook Name

Enter a name for the webhook.

Connection

Establish a connection to your Greenhouse account.

Event

Select or map the event you want to watch. For example, Candidate/Prospect Updated.

Secret Key

Enter (map) the secret key available on the webhook page. You can find the key at Settings > Dev Center > Web Hooks.

6213a13aaeec8.png

Lists candidates and filters by criteria.

Connection

Establish a connection to your Greenhouse account.

Email

Enter (map) the email address to search for the candidates whose

Status

Select or map the status of the application you want to search:

  • Active

  • Converted

  • Hired

  • Rejected

Job ID

Enter (map) or search the Job ID whose candidates you want to search.

Created Before

Enter (map) the date to search the candidates created on or before the specified date.

Created After

Enter (map) the date to search the candidates created on or after the specified date.

Last Activity After

Enter (map) the date to search the candidates whose last activity is on or after the specified date.

Limit

Set the maximum number of candidates Make should return during one execution cycle.

Creates a new prospect.

Connection

Establish a connection to your Greenhouse account.

On behalf of User ID

Enter (map) the User ID that is creating the new prospect.

First Name

Enter (map) the prospect's first name.

Last Name

Enter (map) the prospect's last name.

Applications

Add the prospect's applications:

Job ID

Enter (map) the Job ID to which you want to add the application for the prospect.

Prospect Department ID

Select or map the Department ID applicable for the job. For example, sales.

Prospect Office ID

Select or map the Office ID applicable for the job. For example, South, United States.

Prospect Pool ID

Select or map the Pool ID applicable for the job. For example, Talent Community.

Prospect Pool Stage ID

Select or map the Pool Stage ID applicable for the job. For example, In Discussion.

Prospect Owner ID

Select or map the Owner ID responsible for the prospect's job.

Source ID

Select or map the Source ID of the job application. For example, [Prospecting] Stack.

Referrer

Add the referrer details:

Type

Select or map the referrer type:

  • Email

  • ID

  • Outside

Email

Enter (map) the referrer's email address.

ID

Select or map the referrer ID.

Outside

Enter (map) the details of the external referrer details.

Company

Enter (map) the prospect's company details.

Title

Enter (map) the prospect's job title.

Activity Feed Notes

Add the prospect's activity note details:

User ID

Enter (map) the User ID to whose activity you want to add the note.

Body

Enter (map) the note text.

Visibility

Select or map the note visibility to other users:

  • Admin Only

  • Private

  • Public

Tags

Select the tags for the prospect.

Phone Numbers

Add the phone numbers of the prospect.

Value

Enter (map) the phone number.

Type

Select or map the phone number type. For example, work.

Email Addresses

Add the prospect's email addresses:

Value

Enter (map) the email address.

Type

Select or map the email address type. For example, work.

Social Media Addresses

Add the social media addresses of the prospect. For example, Facebook.

Website Addresses

Add the prospect's website URL addresses:

Value

Enter (map) the website URL address.

Type

Select or map the website type. For example, a company.

Addresses

Add the prospect's address:

Value

Enter (map) the address.

Type

Select or map the address type. For example, work.

Educations

Add the prospect's education details:

School ID

Enter (map) the prospect's School ID.

Degree ID

Enter (map) the prospect's Degree ID.

Discipline ID

Enter (map) the prospect's Discipline ID. For example, Mathematics

Start Date

Enter (map) the start date of the education course.

End Date

Enter (map) the end date of the education course.

Employments

Add the prospect's previous employment details:

Company Name

Enter (map) the company name.

Title

Enter (map) the prospect's job title.

Start Date

Enter (map) the start date of the employment at the company.

End Date

Enter (map) the end date of the employment at the company.

Recruiter

Add the recruiter information:

Recruiter ID

Enter (map) the Recruiter ID assigned for the prospect.

Recruiter Email

Enter (map) the recruiter's email address.

Coordinator

Add the coordinator information:

Coordinator ID

Enter (map) the coordinator ID assigned for the prospect.

Coordinator Email

Enter (map) the coordinator's email address.

Custom Fields

Add the custom fields for the candidate:

School Name

Select or map the prospect's school name.

Degree

Select or map the prospect's degree.

Discipline

Select or map the prospect's discipline.

Revelian Overall Score

Select or map the prospect's overall score in the course.

Assessment Start Date

Enter (map) the start date of the job assessment.

Assessment Completion Date

Enter (map) the end date of the job assessment.

Birthdate

Enter (map) the prospect's date of birth.

Consent

Select or map the consent type provided:

  • Consent Pending

  • Consent Given

  • Consent Declined

Consent Date

Enter (map) the date the consent was provided by the prospect.

Consent Email Automatic

Select whether the consent was provided automatically through email.

Consent Email Opened Date

Enter (map) the date when the consent email was opened by the prospect.

Creates a new candidate.

Connection

Establish a connection to your Greenhouse account.

On behalf of User ID

Enter (map) the User ID that is creating the new candidate.

First Name

Enter (map) the candidate's first name.

Last Name

Enter (map) the candidate's last name.

Applications

Add the candidate's applications:

Job ID

Enter (map) the Job ID to which you want to add the application for the candidate.

Prospect Department ID

Select or map the Department ID applicable for the job. For example, sales.

Prospect Office ID

Select or map the Office ID applicable for the job. For example, South, United States.

Prospect Pool ID

Select or map the Pool ID applicable for the job. For example, Talent Community.

Prospect Pool Stage ID

Select or map the Pool Stage ID applicable for the job. For example, In Discussion.

Prospect Owner ID

Select or map the Owner ID responsible for the candidate's job application.

Source ID

Select or map the Source ID of the job application. For example, [Prospecting] Stack.

Referrer

Add the referrer details:

Type

Select or map the referrer type:

  • Email

  • ID

  • Outside

Email

Enter (map) the referrer's email address.

ID

Select or map the referrer ID.

Outside

Enter (map) the details of the external referrer details.

Company

Enter (map) the candidate's company details.

Title

Enter (map) the candidate's job title.

Activity Feed Notes

Add the candidate's activity note details:

User ID

Enter (map) the User ID to whose activity you want to add the note.

Body

Enter (map) the note text.

Visibility

Select or map the note visibility to other users:

  • Admin Only

  • Private

  • Public

Tags

Select the tags for the candidate.

Phone Numbers

Add the phone numbers of the candidate.

Value

Enter (map) the phone number.

Type

Select or map the phone number type. For example, work.

Email Addresses

Add the prospect's email addresses:

Value

Enter (map) the email address.

Type

Select or map the email address type. For example, work.

Social Media Addresses

Add the social media addresses of the candidate. For example, Facebook.

Website Addresses

Add the candidate's website URL addresses:

Value

Enter (map) the website URL address.

Type

Select or map the website type. For example, a company.

Addresses

Add the candidate's address:

Value

Enter (map) the address.

Type

Select or map the address type. For example, work.

Educations

Add the candidate's education details:

School ID

Enter (map) the candidate's School ID.

Degree ID

Enter (map) the candidate's Degree ID.

Discipline ID

Enter (map) the candidate's Discipline ID. For example, Mathematics.

Start Date

Enter (map) the start date of the education course.

End Date

Enter (map) the end date of the education course.

Employments

Add the candidate's previous employment details:

Company Name

Enter (map) the company name.

Title

Enter (map) the candidate's job title.

Start Date

Enter (map) the start date of the employment at the company.

End Date

Enter (map) the end date of the employment at the company.

Recruiter

Add the recruiter information:

Recruiter ID

Enter (map) the Recruiter ID assigned for the candidate.

Recruiter Email

Enter (map) the recruiter's email address.

Coordinator

Add the coordinator information:

Coordinator ID

Enter (map) the coordinator ID assigned for the candidate.

Coordinator Email

Enter (map) the coordinator's email address.

Custom Fields

Add the custom fields for the candidate:

School Name

Select or map the candidate's school name.

Degree

Select or map the candidate's degree.

Discipline

Select or map the candidate's discipline.

Revelian Overall Score

Select or map the candidate's overall score in the course.

Assessment Start Date

Enter (map) the start date of the job assessment.

Assessment Completion Date

Enter (map) the end date of the job assessment.

Birthdate

Enter (map) the candidate's date of birth.

Consent

Select or map the consent type provided:

  • Consent Pending

  • Consent Given

  • Consent Declined

Consent Date

Enter (map) the date the consent was provided by the prospect.

Consent Email Automatic

Select whether the consent was provided automatically through email.

Consent Email Opened Date

Enter (map) the date when the consent email was opened by the candidate.

Updates a candidate by their ID.

Connection

Establish a connection to your Greenhouse account.

On behalf of User ID

Enter (map) the User ID that is creating the new candidate.

Candidate ID

Enter (map) the Candidate ID whose details you want to update.

First Name

Enter (map) the candidate's first name.

Last Name

Enter (map) the candidate's last name.

Applications

Add the candidate's applications:

Job ID

Enter (map) the Job ID to which you want to add the application for the candidate.

Prospect Department ID

Select or map the Department ID applicable for the job. For example, sales.

Prospect Office ID

Select or map the Office ID applicable for the job. For example, South, United States.

Prospect Pool ID

Select or map the Pool ID applicable for the job. For example, Talent Community.

Prospect Pool Stage ID

Select or map the Pool Stage ID applicable for the job. For example, In Discussion.

Prospect Owner ID

Select or map the Owner ID responsible for the candidate's job application.

Source ID

Select or map the Source ID of the job application. For example, [Prospecting] Stack.

Referrer

Add the referrer details:

Type

Select or map the referrer type:

  • Email

  • ID

  • Outside

Email

Enter (map) the referrer's email address.

ID

Select or map the referrer ID.

Outside

Enter (map) the details of the external referrer details.

Company

Enter (map) the candidate's company details.

Title

Enter (map) the candidate's job title.

Activity Feed Notes

Add the candidate's activity note details:

User ID

Enter (map) the User ID to whose activity you want to add the note.

Body

Enter (map) the note text.

Visibility

Select or map the note visibility to other users:

  • Admin Only

  • Private

  • Public

Tags

Select the tags for the candidate.

Phone Numbers

Add the phone numbers of the candidate.

Value

Enter (map) the phone number.

Type

Select or map the phone number type. For example, work.

Email Addresses

Add the prospect's email addresses:

Value

Enter (map) the email address.

Type

Select or map the email address type. For example, work.

Social Media Addresses

Add the social media addresses of the candidate. For example, Facebook.

Website Addresses

Add the candidate's website URL addresses:

Value

Enter (map) the website URL address.

Type

Select or map the website type. For example, a company.

Addresses

Add the candidate's address:

Value

Enter (map) the address.

Type

Select or map the address type. For example, work.

Educations

Add the candidate's education details:

School ID

Enter (map) the candidate's School ID.

Degree ID

Enter (map) the candidate's Degree ID.

Discipline ID

Enter (map) the candidate's Discipline ID. For example, Mathematics

Start Date

Enter (map) the start date of the education course.

End Date

Enter (map) the end date of the education course.

Employments

Add the candidate's previous employment details:

Company Name

Enter (map) the company name.

Title

Enter (map) the candidate's job title.

Start Date

Enter (map) the start date of the employment at the company.

End Date

Enter (map) the end date of the employment at the company.

Recruiter

Add the recruiter information:

Recruiter ID

Enter (map) the Recruiter ID assigned for the candidate.

Recruiter Email

Enter (map) the recruiter's email address.

Coordinator

Add the coordinator information:

Coordinator ID

Enter (map) the coordinator ID assigned for the candidate.

Coordinator Email

Enter (map) the coordinator's email address.

Custom Fields

Add the custom fields for the candidate:

School Name

Select or map the candidate's school name.

Degree

Select or map the candidate's degree.

Discipline

Select or map the candidate's discipline.

Revelian Overall Score

Select or map the candidate's overall score in the course.

Assessment Start Date

Enter (map) the start date of the job assessment.

Assessment Completion Date

Enter (map) the end date of the job assessment.

Birthdate

Enter (map) the candidate's date of birth.

Consent

Select or map the consent type provided:

  • Consent Pending

  • Consent Given

  • Consent Declined

Consent Date

Enter (map) the date the consent was provided by the prospect.

Consent Email Automatic

Select whether the consent was provided automatically through email.

Consent Email Opened Date

Enter (map) the date when the consent email was opened by the candidate.

Adds a note to the candidate by their ID.

Connection

Establish a connection to your Greenhouse account.

On behalf of User ID

Enter (map) or search the User ID on whose behalf you want to add the note for the candidate.

Candidate ID

Enter (map) the Candidate ID to which you want to add the note.

User ID

Enter (map) or search the User ID who is adding the note for the candidate.

Body

Enter the note text.

Visibility

Select or map the option as to who can view the note:

  • Admin Only

  • Private

  • Public

Uploads an attachment to a candidate or prospect by their ID.

Connection

Establish a connection to your Greenhouse account.

On behalf of User ID

Enter (map) or search the User ID on whose behalf you want to add the attachment for the candidate.

Candidate ID

Enter (map) the Candidate ID to which you want to add the attachment.

Type

Select or map the attachment type:

  • Admin Only

  • Resume

  • Cover Letter

Upload By

Select or map the file by:

  • URL

  • File

File Name

Enter (map) the file name of the attachment.

URL

Enter (map) the URL.

Content

Enter (map) the content of the file.

Content Type

Select or map the content-type of the attachment.

Job

Triggers when a job is created, updated, approved, or deleted.

Note

See the Setting Up Greenhouse Webhooks section to add the webhook to your Greenhouse account.

Webhook Name

Enter a name for the webhook.

Connection

Establish a connection to your Greenhouse account.

Event

Select or map the event you want to watch:

  • Job Created

  • Job Updated

  • Job Approved

  • Job Deleted

Secret Key

Enter (map) the secret key available on the webhook page. You can find the key at Settings > Dev Center > Web Hooks.

6213a13aaeec8.png

Triggers when a job post is created, updated, deleted or a job interview stage is deleted.

Note

See the Setting Up Greenhouse Webhooks section to add the webhook to your Greenhouse account.

Webhook Name

Enter a name for the webhook.

Connection

Establish a connection to your Greenhouse account.

Event

Select or map the event you want to watch:

  • Job Post Created

  • Job Post Updated

  • Job Post Deleted

  • Job Interview Stage Deleted

Secret Key

Enter (map) the secret key available on the webhook page. You can find the key at Settings > Dev Center > Web Hooks.

6213a13aaeec8.png

Triggers when an offer is created, approved, updated, or deleted.

Note

See the Setting Up Greenhouse Webhooks section to add the webhook to your Greenhouse account.

Webhook Name

Enter a name for the webhook.

Connection

Establish a connection to your Greenhouse account.

Event

Select or map the event you want to watch:

  • Offer Created

  • Offer Updated

  • Offer Approved

  • Offer Deleted

Secret Key

Enter (map) the secret key available on the webhook page. You can find the key at Settings > Dev Center > Web Hooks.

6213a13aaeec8.png

Lists jobs and filters by criteria.

Connection

Establish a connection to your Greenhouse account.

Status

Select or map the status of the job you want to search:

  • Open

  • Closed

  • Draft

Department ID

Select or map the Department ID whose jobs you want to search.

Office ID

Select or map the Office ID to search for the jobs that match the specified ID.

Requisition ID

Enter (map) the Requisition ID to search for the jobs that match the specified ID.

Opening ID

Enter (map) the Opening ID to search for the jobs that match the specified ID.

External Department ID

Enter (map) the External Department ID to search for the jobs that match the specified ID.

Created Before

Enter (map) the date to search the application created on or before the specified date.

Created After

Enter (map) the date to search the application created on or after the specified date.

Updated Before

Enter (map) the date to search the application updated on or before the specified date.

Updated After

Enter (map) the date to search the application updated on or after the specified date.

Limit

Set the maximum number of jobs Makeshould return during one execution cycle.

Lists job posts and filters by criteria.

Connection

Establish a connection to your Greenhouse account.

Live Job Posts

Select whether you want to search only the live job posts.

Active Job Posts

Select whether you want to search only the active job posts.

Created Before

Enter (map) the date to search the application created on or before the specified date.

Created After

Enter (map) the date to search the application created on or after the specified date.

Updated Before

Enter (map) the date to search the application updated on or before the specified date.

Updated After

Enter (map) the date to search the application updated on or after the specified date.

Limit

Set the maximum number of job posts Make should return during one execution cycle. The default value is 10.

Lists approval flows by the job ID.

Connection

Establish a connection to your Greenhouse account.

Job ID

Enter (map) or search the Job ID whose approval flow details you want to list.

Limit

Set the maximum number of approval flows Make should return during one execution cycle. The default value is 10.

Retrieves the details of a job by its ID.

Connection

Establish a connection to your Greenhouse account.

Job ID

Enter (map) or search the Job ID whose details you want to retrieve.

Retrieves the details of a job post by its ID.

Connection

Establish a connection to your Greenhouse account.

Job Post ID

Enter (map) or search the Job Post ID whose details you want to retrieve.

Other

Performs an arbitrary authorized API call.

Connection

Establish a connection to your Greenhouse account.

URL

Enter a path relative to https://harvest.greenhouse.io. For example: /v1/applications

Note

For the list of available endpoints, refer to the Greenhouse API Documentation.

Method

Select the HTTP method you want to use:

GET to retrieve information for an entry.

POST to create a new entry.

PUT to update/replace an existing entry.

PATCH to make a partial entry update.

DELETE to delete an entry.

Headers

Enter the desired request headers. You don't have to add authorization headers; we already did that for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.

The following API call returns all the offers from your Greenhouse account:

URL: /v1/offers

Method: GET

6213a13bc5844.png

Matches of the search can be found in the module's Output under Bundle > Body. In our example, 20 offers were returned:

6213a13ce8096.png
  1. Open any Watch module, enter the details as mentioned in the respective module descriptions, click Save and copy the URL address to your clipboard. Click OK and save the trigger.

    6213a13e559ec.gif
  2. Go to your Greenhouse account. Click Settings > Dev Center > Web Hooks > Web Hooks.

    6213a140d66c6.png
  3. Enter the details as follows:

    Name of this webhook

    Enter the webhook name.

    When

    Select or map the event for which you want to receive the triggers.

    Endpoint URL

    Enter (map) the URL address copied in step 1.

    Secret Key

    Enter (map) the secret key for the webhook. (Optional) You can use your account password.

    Error recipient mail

    Enter (map) the email address to which you want to send the errors.

    Disabled

    Select Yes to enable the webhook.

  4. Click Create Web hook.

You have successfully added the webhook.