Board
Board connector tutorial
Definition
A board is a container or folder that holds job offers data. It stores Job
objects.
Boards are created from HrFlow.ai developer platform.
Boards are identified my their board_key
.
You can retrieve board key from HrFlow.ai developer platform under Connections > My boards once you have created an account.
How to create & manage a board
Prerequisites
Step 1: Go to the Connectors Marketplace
Step 2: Choose the HTTP API Board type
You can either scroll down or just select the Server Board category to get into the HTTP API type.
Step 3: Click on the button «Create board»
After choosing your Board type, a window will be opened showing you video tutorials and a description.
Step 4: Configure your Board
- Mandatory: Chose a recognizable Board name that you can easily remember, and other users can easily recognize.
- Mandatory: Write a clear Board description that explains the collection of job offers that will be imported in your board.
- Optional: If you want to hide your Board from your teammates, you can make the Board private.
- Optional: In the Board managers field, you can choose other team members to manage the Board with you. They will be automatically added as Board followers as soon as the Board is created.
Finally, click on Create Board at the bottom left.
After creating your Board, it will be available in Left Sidebar > Connections > My Boards.
Indexing API requires the
board_key
To Index jobs in a Board with the API, you must specify its
board_key
in your API request. You will find it in the Overview section of your Board.
Advanced Topics
1. Debugging a Board
When you create or import a job to a Board, you can see the job in the 'All Jobs' section.
2. Disabling/Enabling a Board
You can pause or continue accepting resumes and jobs on a Board any time by flipping the «Disable» switcher at the bottom of the section Overview.
3. Changing the settings of a Board
Each Board has custom parameters. The 'Settings' section allows you to edit them.
4. Archiving a Board
You can click the button «Archive this board» to delete all the jobs in a board.
Archiving a Board
This operation is irreversible, and all the jobs in the Board will be definitively lost.
Updated about 20 hours ago