Create, Configure a Source
Source Connectors Tutorial: from Source creation to start collecting Profiles.
The HrFlow.ai Portal offers multiple types of Sources to simplify your profiles' data collection from any channel or tool.
The Connectors Marketplace lists all the types of available Sources on HrFlow.ai.
In this article, we'll give the example of creating an HTTP API Source. However, the process is almost the same for all the other types of Source Connectors.
Prerequisites
- Having an HrFlow.ai account. To signup, please visit https://hrflow.ai/signup
Step 1: Go to the Connectors Marketplace
Step 2: Choose the HTTP API Source type
You can either scroll down or just select the Server Source category to get into the HTTP API type.
Step 3: Click on the button «Create source»
After choosing your Source type, a window will be opened showing you video tutorials and a description.
Step 4: Configure your Source
- Mandatory: Chose a recognizable Source name that you can easily remember, and other users can easily recognize.
- Optional: If you want to hide your Source from your teammates, you can make the Source private.
- Optional: In the Source managers field, you can choose other team members to manage the Source with you. They will be automatically added as Source followers as soon as the Source is created.
Finally, click on «Create source» at the bottom left.
After creating your Source, it will be available in Left Sidebar > Connections > My Sources .
Indexing API and Parsing API require
source_key
To Index or Parse profiles in a Source with the API, you must specify its
source_key
in your API request. You will find it in the Overview section of your Source.
Advanced Topics
1. Activating Real-time Parsing for a Source
When a user creates a Source, the resume parsing is set to batch mode by default by default for this Source.
As a consequence, this Source will parse all the resumes sent to it asynchronously.
In this case, the only way to get your results is by sending an extra 'GET' request once your resume parsing has finished.
Asynchronous/Batch mode resume Parsing
To avoid sending many requests, we highly recommend using the Webhook Event 'profile.parsing.success' to get notified when resume parsing has finished.
If you want to activate real-time resume parsing, you just have to send a message with your 'source_key' in the after clicking on the button «Chat with us» in the bottom of the left sidebar. You can also click on the button «Contact us now» in the "Overview" section of the Source to generate the message automatically.
2. Debugging a Source
When you upload a resume or import a profile to a Source, you can see the JSON of the last profiles in the 'Debugger' section.
3. Disabling/Enabling a Source
You can pause or continue accepting resumes and profiles on a Source any time by flipping the «Disable» switcher at the bottom of the section Overview.
4. Changing the settings of a Source
Each Source has custom parameters. The 'Settings' section allows you to edit them.
5. Archiving a Source
You can click the button «Archive this source» to delete all the profiles in a source.
Archiving a Source
This operation is irreversible, and all the items in the will be definitively lost.
Updated about 3 years ago