🌐
Recrubo API
  • Getting Started
    • Introduction
    • Sandbox
    • Async requests
    • Authentication
    • Webhooks
    • Filtering, sorting, pagination and including resources
  • Guides
    • Setting up webhooks
    • Generating flows
    • Editing flows
    • Triggering flows
    • Embedding the Inbox
    • Sending messages
  • Resources
    • API Resource Reference
      • Candidate
      • Conversation
      • Flow
      • FlowRun
      • FlowGeneration
      • Message
      • MessageTemplate
      • MessageThread
      • NodeAction
      • NodeTransition
      • Node
      • VacancyAnalysis
      • Vacancy
      • User
      • WebhookPayload
    • Embeddables
      • Inbox
      • BotStudio
      • GenerateFlow
      • Whatsapp connect button
      • Schedule Form
      • Schedule Table
    • Flow types
      • vacancy_application_flow
  • Management
    • Organizations
Powered by GitBook
On this page
  • Description
  • SessionField
  • Analyze vacancy
  • Parameters
  • Best practices
  1. Resources
  2. Flow types

vacancy_application_flow

Description

The vacancy_application_flow is designed to streamline the process of applying for job openings. It guides users through a series of steps that may include submitting personal details, asking if they possess certain skills and any additional information required by the prospective employer. This flow ensures that all necessary data is collected efficiently, making it easier for both the applicant and the hiring organization to manage the application process.

SessionField

The session field dictates under what variable name the result will be saved in the FlowRun state. You can use this to map the answer of a candidate to a specific field in your ATS.

The SessionField is not required. If left blank, the AI will generate a logical session variable name.

Analyze vacancy

We provide an endpoint to analyze a vacancy to extract skills you can use in the parameters. Please see Analyze vacancy for more details.

Parameters

Field
Type
Description
Example value
Required

vacancyId

UUID

The id of the vacancy within Recrubo. If set we will use the vacancy already existing within Recrubo to generate the flow. This means any given context in the request will be ignored. If not set we will create a vacancy based on the given context.

f8fecd29-c336-45fd-8fb8-376c0d81cd7c

false

knockoutRequirements

json object array

A list of skills that are required for the vacancy, if the candidate does not have these skills he will be disqualified. Set to [] for a flow without knockout skills

[ { "value": "Has 4 years of Java development experience.", "sessionField": "java_skill" }, { "value": "Speaks fluent English.", "sessionField": "speaks_english" } ]

true

preferredRequirements

json object array

A list of skills that are preferred skills for the vacancy, if the candidate does not have these skills they wont be disqualified. Set to [] for a flow without preferred skills.

[{"value":"Is a good team player.","sessionField":"team_player"}]

true

requiredFields

json object array

A list of fields that are required for the candidate to fill in to apply for the vacancy. Available types are: name, email, phoneNumber and postalCode. Set to [] for a flow without required fields.

[ { "value":"name", "sessionField":"first_name"}, { "value":"email","sessionField": "email"} ]

true

optionalFields

json object array

A list of fields that are optional for the candidate to fill in to apply for the vacancy. Like hobbies or favorite color. Set to [] for a flow without optional fields

[ { "value":"Link to Linkedin page", "sessionField":"linkedin_page" } ]

true

Best practices

  • When setting the value key of a skill it is better to use a describing sentence than a keyword. This will help AI to formulate a good question. For example instead of just passing "woodworking". Try passing "Woodworking experience" or "1 year of woodworking experience" instead. Using just tags will work, but it will leave the AI to make guesses regarding the specific question being asked.

  • Try to limit the amount of questions asked to 10. We don't put a hard limit on how many skills you can give but from our experience 10 questions is about the maximum a candidate is willing to answer. Having a lot of questions in a flow will also increase its generation time.

Example FlowGeneration json

    {
       "data": {
        "type": "flowGenerations",
        "attributes": {
            "flowType": "vacancy_application_flow",
            "parameters": {
                "knockoutRequirements": [
                    {
                        "value": "Has 1 year of javascript experience.",
                        "sessionField": "javascript_skill"
                    },
                    {
                        "value": "Fluent in Dutch",
                        "sessionField": "dutch_fluency"
                    }
                ],
                "preferredRequirements": [
                    {
                        "value": "Lives in amsterdam",
                        "sessionField": "location"
                    }
                ],
                "requiredFields": [
                    {
                        "value": "name",
                        "sessionField": "name"
                    },
                    {
                        "value": "email",
                        "sessionField": "email"
                    }
                ],
                "optionalFields": [
                    {
                        "value": "Link to linkedin page.",
                        "sessionField": "linkedin"
                    }
                ]
            },
            "context": {
               "type":"text",
               "value": "Job Title: Java Developer Location: Amsterdam, Netherlands Job Type: Full-time About the Company:At Tech Innovations, we are at the forefront of transforming digital landscapes through our cutting-edge technology solutions. Located in the vibrant city of Amsterdam......." 
            }
        }
    }
}
PreviousFlow typesNextOrganizations

Last updated 1 year ago