Hiring Assistant SDK

Implement the assistant on your site using the embed code.

About the SDK
  • Designed to require minimal code
  • Styles and content are managed in Soigné (not the SDK)
  • By default the hiring assistant is disabled. After installing the SDK, the assistant can be enabled in Soigné.
Elements
  • Banner, Button, Widget
Control visibility and state
  • Anchor links
  • Page tags
  • JavaScript SDK
Options Anchors Methods Analytics QR and direct link
Embed code

Copy and paste this code just above the closing of your head tag to display the widget.

Options

With these options you can configure the behavior of the assistant on your site.

Assistant Id
A 24 character hexadecimal string | string
data-assistant-id
Tags (;)
Semicolon separated string to track the source of your applications | string
data-tags
Page tag

Based on the configuration, the banner and open button will always be shown (on every page) or only when the page has a specific tag. The latter is mostly used, as most implementations lead towards a dedicated Jobs page. In this case, copy and paste the code below inside the body of that page.

Show banner on page
Whether to show the banner on the page
data-show-banner
Show button on page
Whether to show the button on the page
data-show-button
Open the widget after page load
Directly open the widget on page load
data-open
Open the widget on mobile after page load
Directly open the widget on page load on mobile devices
data-open-mobile
Anchors

Use anchors as href in <a>-tags to control the widget.

#hiring-widget-open
Show the widget
#hiring-widget-open-[step]
Shows the widget and opens a specific step in the application wizard (when possible)
#hiring-widget-close
Hides the widget
#hiring-widget-open-job-[jobId]
Show the widget and displays a specific job
Methods

Using JavaScript, you can control the banner, button and widget with the methods below. Obtain a reference to the assistant SDK with window.hiringAssistant.
So, to open the widget, you would call window.hiringAssistant.open().

open()
Opens the hiring widget
Parameters:
initial
boolean
Optional. Whether to open the widget in the initial state
jobId
string
Optional. The job id to open the widget with
initialStep
string
Optional. The initial step to open the widget with
close()
Closes the hiring widget
isOpen()
Returns the state of the widget
Returns:
boolean
isInitialized()
Returns whether the assistant has been successfully initialized
Returns:
boolean
showBanner()
Shows the banner
hideBanner()
Hides the banner
showButton()
Shows the open button
hideButton()
Hides the open button
getBannerState()
Returns the state of the banner
Returns:
object
 {
    presence: 'never' | 'always' | 'on',
    isVisible: boolean
 }
  
The presence of the banner in the implementation.
 - 'never' means the banner is not present and cannot be shown.
 - 'always' means the banner is always shown by default, though it can be hidden using hideBanner().
 - 'on' means the banner is present and visible when a presentation hint is given or showBanner() is called.
getButtonState()
Returns the state of the button
Returns:
object
 {
    presence: 'never' | 'always' | 'on',
    isVisible: boolean
 }
  
The presence of the open button in the implementation:
 - 'never' means the open button is not present and cannot be shown.
 - 'always' means the open button is always shown by default, though it can be hidden using hideButton().
 - 'on' means the open button is present and visible when a presentation hint is given or showButton() is called.
loadOtherAsync()
Reload the assistant with a new assistantId
Parameters:
assistantId
string
The assistant id to use
setTags()
Set the tags for the hiring assistant
Parameters:
tags
string
Semicolon separated string to track the source of your applications
Manually initializing the widget
By loading the SDK script without the data-assistant, the SDK doesn't know what assistant to load and will not initialize. This is a way to manually initialize the assistant by calling 
const assistant = await window.initHiringAssistantAsync(assistantId: string, tags?: string).
 Note that window.hiringAssistant will be available after the initialization. 
 Tracking and analytics
When a gtag, google tag manager or meta pixel is installed on your site, we will send the following events to it.
HiringAssistantExecuteCallToAction
When the visitor click the call to action in the banner
HiringAssistantOpenWidget
When the visitor opens the widget
HiringAssistantCloseWidget
When the visitor closes the widget
HiringAssistantViewStep
When the visitor moves to another step in the application wizard
Parameters:
direction
forward/backward
Whether the visitor moved forward or back
stepName
string
The name of the step
stepIndex
number
The index of the step
HiringAssistantSubmitApplication
When the visitor succesfully applied and submitted their application
Use the widget directly
If you want to link to the widget directly, for example as a QR code or call to action url from an ad, you can use the link below.
Preview