Quickstart

Learning Objectives

In this quickstart, you'll learn to create a sample use case to manage new hire referrals. This will help you learn to use the Paths workspace.

Video Coming soon

Before you start, make sure...

  1. You have the access to the Paths Workspace.

Use Case Overview

Design Pattern: [DP-44] Resource Selection Path

Use Case Description: Submit a candidate referal to either a technical, non-technical, or executive role. Each option has a different action that the end user must take.

[object Object]
Gwen11:43 AM

Can I submit a candidate referral?

[object Object]
Moveworks11:43 AM

Sure! Is this for a technical role?

Technical

Non-technical

Executive

[object Object]
Gwen11:43 AM

Technical

[object Object]
Moveworks11:43 AM

If you're referring a candidate for a technical role, please share this Coding Challenge to start the process.

[object Object]
Gwen11:43 AM

Can I submit a candidate referral?

[object Object]
Moveworks11:43 AM

Sure! Is this for a technical role?

Technical

Non-Technical

Executive

[object Object]
Gwen11:43 AM

Non-Technical

[object Object]
Moveworks11:43 AM

Can you please provide the candidate's name?

[object Object]
Gwen11:43 AM

Jacob Jones

[object Object]
Moveworks11:43 AM

What's their email address?

[object Object]
Gwen11:43 AM

jacob@acme.com

Store referral information in HRIS (API Documentation)

[object Object]
Moveworks11:43 AM

Thank you! Your candidate referral has been submitted.

Step 1: Create a New Path

  1. Go to Paths Workspace and click Create.
  2. Provide a name & description (Basic Info). Feel free to copy from below
    1. Name: 💼 Submit Candidate Referral
    2. Description: Effortlessly refer top talent in your network to join us as employees
1-description.png
Do not enter placeholder values (test, demo, etc.)

These values will be

  1. Shown directly to your users
  2. Used to build the generative intent
  1. Click Next to proceed.

Step 2: Design Conversation

Moveworks generates conversation experiences based on example stories. You can learn more about this in story-driven development.

To build this New Hire Referral Path, we're going to write two stories, one for technical roles & the other for non-technical roles. Each story has

  • A list of slots - these are questions that collect information from users. Read more about slots.
  • A solution - usually an answer or an API call to kick-off some process. Read more about solution types here.

Build the stories out in the Story Editor. Switch between them using the Story Navigator.

Untitled

Story 1: Referrals for Technical Roles

In this story, we’ll focus on technical candidates

  1. In an example conversation, a recruiter would ask if the candidate is technical. To emulate this behavior go to the Story Builder, click ADD A BOT ACTION, then click Ask a question. Untitled
  2. Describe your question detail & the individual options will get auto-generated.

    For our tutorial, you can use this prompt:

    Copy
    Copied
    Is this for a technical role?
    Untitled
  3. You should get Technical and Non-Technical, let’s add a separate special option for hiring executives (Executive)
    1. Click + ADD OPTION & add an option for Executive.
  4. Click Create question. You should see the question is added to your Story Editor. Untitled
  5. For technical referrals, let’s advise employees to share a coding challenge with their candidate.
    1. Click on the Technical button & add an action to Present an answer or text-response Untitled
    2. You can use any answer from your knowledge base, but let’s Write a text response here. Feel free to use this prompt:
      Copy
      Copied
      Please share this link coding challenge with your candidate to start them with their application: https://www.freecodecamp.org/learn/coding-interview-prep/algorithms/implement-merge-sort.
      Untitled
  6. Click Create Answer

You’re done with your first story (example conversation)!

Story 2: Referrals for Non-Technical Roles

In this story we’ll assist non-technical candidates

  1. We’re reusing the same question from Story 1, so you can use the Story Navigator to open a new story using that same question. Select Non-Technical Untitled
  2. Let’s collect the candidate’s name
    1. Click Ask a question
    2. Type What is the candidate's name? as the question detail
    3. Click Create question
    Untitled
  3. Now repeat for the candidate’s email
    1. Click Ask a question
    2. Type What is the candidate's email? as the question detail
    3. Click Create question
  4. Let’s use this information to submit referrals to your team. We provided you a Demo API here:
    1. Head to Referral Tester to get your own unique team id
    2. Copy over your unique team_id that you’ll use for testing Untitled
  5. Now back in Paths, click Execute an API as your next bot action
    1. Choose creator_studio_demo_function as your connector & click Next Untitled
    2. Paste /submitReferral into the API endpoint path field.
    3. Select Method as POST
    4. Now add the team id & the user-provided name & email in the API Request Body.
      • We can directly access these values using their labels. Replace your team_id into <YOUR-TEAM-ID-HERE> & use this as the Request Body:
      Copy
      Copied
      {
          "team_id": "<YOUR-TEAM-ID-HERE>",
          "name": "{{job candidate name}}",
          "email": "{{candidate email address}}"
      }
      Untitled
    5. Set the Content-Type Header to application/json
    6. Add an API description, you can also use the one below
      Copy
      Copied
      API action to automatically submit referrals for non-technical roles
    7. Click Submit Untitled

You can use our API configuration guide for advanced API setup details.

Here’s what your conversation setup should look like. Review & click Next. Untitled

Step 3: Refine Triggering

Based on your stories & conversation description, Moveworks auto-generates an intent that captures how end-users might ask about this, but it needs your help to fine-tune it.

You can read more about how this works in Generative Intents.

  1. Now you can start classifying similar utterances. Click Should trigger or Should not trigger to let Moveworks know if the bot should respond with this conversation experience for similar utterances. Untitled
  2. If you want to add more examples, you can also add other ones below.
    Copy
    Copied
    My buddy said she wanted to work here, how do I hire her?
    Untitled
  3. Keep classifying until Moveworks tells you that the Triggering Review is ready. Untitled
  4. [Optional] You can also click “Review triggering" to see how it’ll perform against other production utterances, and test your triggering before publishing. See more in our Triggering Review deep dive.

Step 4: Set up Launch

Let’s publish your Path so you can test it out in your bot

Moveworks_Self-Service_Portal.png
  1. Choose Launch to selected emails(Testing)
  2. Add your work email address under Allow Emails Values
  3. Click Launch.

You can learn more about the other launch management options here.

Step 5: Test in the bot

  1. Wait up to 2 minutes
  2. Test with any utterance & see your conversation in the bot.
    Copy
    Copied
    I want to hire my buddy, how do I get started?