Quickstart
Learning Objectives
In this quickstart, you'll learn to create a sample conversation to manage new hire referrals. This will help you learn to use the Paths workspace.
Video Coming soon
Before you start, make sure...
- You have the access to the Paths Workspace.
Step 1: Create a New Path
- Go to Paths Workspace and click
Create
. - Provide a name & description. Feel free to copy from below
- Name:
Submit Candidate Referral
- Description:
Use this conversation to submit a referral in your organization
- Name:
test
, demo
, etc.)
Do not enter placeholder values (These values will be
- Shown directly to your users
- Used to build the generative intent
- Click
Next
to proceed.
Step 2: Add your Stories
Moveworks generates conversation experiences based on example stories. You can learn more about this in expert emulation.
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 questions - these are question prompts to collect information from users. Read more about questions here.
- 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.
Story 1: Referrals for Technical Roles
In this story, we’ll focus on technical candidates
- 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 clickAsk a question
. - Describe your question detail & the individual options will get auto-generated.
For our tutorial, you can use this prompt:
Is this for a technical role?
- You should get
Technical
andNon-Technical
, let’s add a separate special option for hiring executives (Executive)- Click
+ ADD OPTION
& add an option forExecutive
.
- Click
- Click
Create question
. You should see the question is added to your Story Editor. - For technical referrals, let’s advise employees to share a coding challenge with their candidate.
- Click on the
Technical
button & add an action toPresent an answer or text-response
- You can use any answer from your knowledge base, but let’s
Write a text response
here. Feel free to use this prompt: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.
- Click on the
- 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
- 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
- Let’s collect the candidate’s name
- Click
Ask a question
- Type
What is the candidate's name?
as the question detail - Click
Create question
- Click
- Now repeat for the candidate’s email
- Click
Ask a question
- Type
What is the candidate's email?
as the question detail - Click
Create question
- Click
- Let’s use this information to submit referrals to your team. We provided you a Demo API here:
- Head to Referral Tester to get your own unique team id
- Copy over your unique
team_id
that you’ll use for testing
- Now back in Paths, click
Execute an API
as your next bot action- Choose
creator_studio_demo_function
as your connector & clickNext
- Paste
/submitReferral
into the API endpoint path field. - Select Method as
POST
- 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:
{ "team_id": "<YOUR-TEAM-ID-HERE>", "name": "{{job candidate name}}", "email": "{{candidate email address}}" }
- We can directly access these values using their labels. Replace your
- Set the
Content-Type
Header toapplication/json
- Add an API description, you can also use the one below
API action to automatically submit referrals for non-technical roles
- Click
Submit
- Choose
You can use our API configuration guide for advanced API setup details.
Here’s what your conversation setup should look like. Review & click Next
.
Step 3: Build your Generative Intent
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.
- 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.
- If you want to add more examples, you can also add other ones below.
My buddy said she wanted to work here, how do I hire her?
- Keep classifying until Moveworks tells you that the Triggering Review is ready.
- [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: Publish your Path
Let’s publish your Path so you can test it out in your bot
- Choose Launch to selected emails(Testing)
- Add your work email address under Allow Emails Values
- Click Launch.
You can learn more about the other launch management options here.
Step 5: Test in the bot
- Wait up to 2 minutes
- Test with any utterance & see your conversation in the bot.
I want to hire my buddy, how do I get started?
🎉 Congrats! Now, make it more powerful
Not sure where to start? Check out our Idea Library for the touch of inspiration you need!