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

Step 1: Go to the Connectors Marketplace

Left Sidebar > Connections > Connectors Marketplace > SourcesLeft Sidebar > Connections > Connectors Marketplace > Sources

Left Sidebar > Connections > Connectors Marketplace > Sources

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.

Left Sidebar > Connections > Connectors Marketplace > Sources > ServerLeft Sidebar > Connections > Connectors Marketplace > Sources > Server

Left Sidebar > Connections > Connectors Marketplace > Sources > Server

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.

Left Sidebar > Connections > Connectors Marketplace > Sources > Server > HTTP APILeft Sidebar > Connections > Connectors Marketplace > Sources > Server > HTTP API

Left Sidebar > Connections > Connectors Marketplace > Sources > Server > HTTP API

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.

Left Sidebar > Connections > Connectors Marketplace > Sources > Server > HTTP API > «Create a source»Left Sidebar > Connections > Connectors Marketplace > Sources > Server > HTTP API > «Create a source»

Left Sidebar > Connections > Connectors Marketplace > Sources > Server > HTTP API > «Create a source»

After creating your Source, it will be available in Left Sidebar > Connections > My Sources .

Left Sidebar > Connections > My SourcesLeft Sidebar > Connections > My Sources

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.

Left Sidebar > Connections > My Sources > My http_api sourceLeft Sidebar > Connections > My Sources > My http_api source

Left Sidebar > Connections > My Sources > My http_api source

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.

Left Sidebar > Connections > My Sources > My http_api source > Overview > «Chat with us»Left Sidebar > Connections > My Sources > My http_api source > Overview > «Chat with us»

Left Sidebar > Connections > My Sources > My http_api source > Overview > «Chat with us»

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.

Left Sidebar > Connections > My Sources > My http_api source > DebuggerLeft Sidebar > Connections > My Sources > My http_api source > Debugger

Left Sidebar > Connections > My Sources > My http_api source > Debugger

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.

Left Sidebar > Connections > My Sources > My http_api source > Overview > «Disable»Left Sidebar > Connections > My Sources > My http_api source > Overview > «Disable»

Left Sidebar > Connections > My Sources > My http_api source > Overview > «Disable»

4. Changing the settings of a Source

Each Source has custom parameters. The 'Settings' section allows you to edit them.

Left Sidebar > Connections > My Sources > My http_api source > SettingsLeft Sidebar > Connections > My Sources > My http_api source > Settings

Left Sidebar > Connections > My Sources > My http_api source > Settings

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.

Left Sidebar > Connections > My Sources > My http_api source > Overview > «Archive this source»Left Sidebar > Connections > My Sources > My http_api source > Overview > «Archive this source»

Left Sidebar > Connections > My Sources > My http_api source > Overview > «Archive this source»


Did this page help you?