How to use IBM App Connect with Greenhouse
Greenhouse is a talent acquisition software that provides tools and services to assist businesses with the hiring process.
- App Connect Enterprise as a Service connector
Local
connector in containers (Continuous Delivery release) 12.0.9.0-r3 or
later
Connecting to Greenhouse
Complete the connection fields that you see in the App Connect Designer Catalog page or flow editor. If necessary, work with your Greenhouse administrator to obtain these values.
| Connection field | Description | Applicability |
|---|---|---|
| Email ID | The email ID to access your Greenhouse account. | App Connect Enterprise as a Service and App Connect in containers |
| API key | The API key used to access your Greenhouse account. |
- Log in to your Greenhouse account.
- On the Greenhouse home page, click the Configure (settings) icon.
- Go to .
- Click the Create New API Key button.
- In the Create New Credential dialog box, specify the following:
- API Type: Harvest
- Partner: Custom
- Description: Enter a description for your API key
- Click Manage Permissions to generate the API key
- Click the Copy button to copy your API key value, and save it somewhere
safe.Note: You cannot access the API key again after clicking I have stored the API Key.
To connect to a Greenhouse endpoint from the App Connect Designer Catalog page for the first time, expand Greenhouse, then click Connect. For more information, see Managing accounts.
Before you use the account that is created in App Connect in a flow, rename the account to something meaningful that helps you to identify it. To rename the account on the Catalog page, select the account, open its options menu (⋮), then click Rename Account.
General considerations
Before you use App Connect Designer with Greenhouse, take note of the following considerations:
- (General consideration) You can see lists of the trigger events and
actions that are available on the Catalog page of the App Connect Designer.
For some applications, the events and actions in the catalog depend on the environment and whether the connector supports configurable events and dynamic discovery of actions. If the application supports configurable events, you see a Show more configurable events link under the events list. If the application supports dynamic discovery of actions, you see a Show more link under the actions list.
- (General consideration) If you are using multiple accounts for an application, the set of fields that is displayed when you select an action for that application can vary for different accounts. In the flow editor, some applications always provide a curated set of static fields for an action. Other applications use dynamic discovery to retrieve the set of fields that are configured on the instance that you are connected to. For example, if you have two accounts for two instances of an application, the first account might use settings that are ready for immediate use. However, the second account might be configured with extra custom fields.
Events and actions
Greenhouse events
These events are for changes in this application that trigger a flow to start completing the actions in the flow.
Show more configurable events: Events that are shown by default are pre-configured by using optimized connectivity. More items are available after you configure events that can trigger a flow by polling this application for new or updated objects. For more information about configurable events, see Configuring polled events to trigger flows.
Greenhouse actions
Your flow completes these actions on this application.
| Object | Action | Description |
|---|---|---|
| Applications | Add application to candidate | Creates a new application for an existing candidate or prospect |
| Retrieve applications | Retrieves applications of an organization | |
| Convert prospect application to candidate | Converts a prospect application to a candidate on a job. If a nonprospect application is provided, an error is returned. | |
| Add attachment to application | Post an attachment to an application by the application ID | |
| Candidates | Create candidate | Creates a new candidate |
| Retrieve candidates | Retrieves candidates from an organization | |
| Update candidate | Updates or patches a single candidate by its ID | |
| Update or create candidate | Updates or creates a single candidate by its ID | |
| Add attachment to candidate | Post an attachment to a candidate's profile by the candidate ID | |
| Job posts | Retrieve job posts | Retrieves all jobs from an organization |
| Jobs | Create job from existing job | Creates jobs for an organization from a template |
| Retrieve jobs | Retrieves all jobs from an organization | |
| Update job | Updates the job for an organization | |
| Update or create job | Updates or creates a job for an organization | |
| Prospects | Create prospect | Creates a new prospect. The difference between a prospect and a candidate is that a prospect can be on no jobs or many jobs. A prospect application cannot be added to a job stage. When a prospect is ready to be added to a job stage, they can be converted to a candidate in Greenhouse. |
| Create application for prospect | Creates a new application for an existing prospect | |
| Scheduled interviews | Create scheduled interview | Creates a new scheduled interview |
| Retrieve scheduled interviews | Lists all scheduled interviews of an organization | |
| Delete scheduled interview | Delete a scheduled interview by ID | |
| Update scheduled interview | Updates a scheduled Interview | |
| Update or create scheduled interview | Updates or creates a scheduled interview | |
| Job stages | Retrieve job stages | Retrieves details of the job stages |