Skip to main content

​
Purpose & Scope

StackOne allows you to integrate with SmartRecruiters for Assessment and Background Check to receive webhook notifications whenever a user sends the test to a candidate, update the test result, and see the result on the candidate profile in SmartRecruiters. This guide covers the Assessments and Background Checks unified use case. For the end-to-end flow, see the Unified Use Case Overview. This guide covers how you can set up/configure integration at SmartRecruiters and integrate with StackOne.

​
Partnership Requirements

​
SmartRecruiters Marketplace Partnership

To integrate with SmartRecruiters for assessments and background checks, you must apply to become a partner through the SmartRecruiters Marketplace:
  • Partnership Required: Yes, formal partnership application required
  • Marketplace Application: SmartRecruiters Marketplace
  • Plan Requirements: Partnership approval required regardless of SmartRecruiters plan tier
  • Support Contact: Available through marketplace partner portal after approval

​
Application Process

1

Submit Partnership Application

  1. Visit the SmartRecruiters Marketplace
  2. Click on Get started or Join the Marketplace
  3. Complete the partnership application form with your company details
2

Approval and Onboarding

Upon approval, you’ll receive:
  • Access to SmartRecruiters Partner Portal
  • API credentials and documentation
  • Marketplace listing guidelines
  • Technical support contact information
Partnership approval is mandatory before proceeding with the technical integration.

​
Provider Side Setup

​
SmartRecruiters Configuration

Once your application is listed on the SmartRecruiters Marketplace, no additional external setup is required on the provider side. End users will be able to discover and enable your integration directly from the marketplace and proceed with the configuration.

​
SmartRecruiters API Documentation

For detailed API specifications, refer to:

​
StackOne Configuration

​
Enable SmartRecruiters in StackOne Dashboard

1

Navigate to Integrations

  1. Log into your StackOne Dashboard
  2. Navigate to the ATS category on the Integrations page
  3. Find and enable SmartRecruiters
SmartRecruiters Integration Setup
2

Complete Configuration Form

Fill in the SmartRecruiters Configuration form with the following details:
  • Authentication Type: Select OAuth2 - Assessments/Background checks for standard integration
  • Partner Category: Select Assessment or Background Check based on your integration typeß
  • Partner Client ID: Enter your SmartRecruiters Client ID from Partner Portal
  • Partner Client Secret: Enter your SmartRecruiters Client Secret from Partner Portal
  • Package’s List Endpoint URL: Your endpoint URL that StackOne will call to retrieve packages
  • Package ID: If you do not have the Package List Endpoint URL, you can specify a particular package ID that will be visible to the recruiter when they wish to send the test to the candidate
  • SmartRecruiters Supported Assessment Types: Please select one of the assessment types supported by SmartRecruiters
SmartRecruiters Configuration Form
3

Save Configuration

Click Confirm or Save Changes to enable your OAuth APIs and allow end-users to link their SmartRecruiters accounts via the StackOne Hub.
4

Enable Webhook Events

Configure webhook notifications for the following events based on your selected integration category:
  • assessment.created - When a recruiter sends an assessment to a candidate
  • background_check.created - When a recruiter initiates a background check
1

Add a Webhook

Navigate to the Webhooks page, click on Add webhook.
External Trigger Token
Fill out the form:
  • Name: Enter your webhook with a recognisable name
  • URL: Enter the URL where the webhook will send the notification of the enabled events
External Trigger Token
2

Configure Event

Enable webhook events from the Events tab for Assessment & Background Check, such as Assessments Order & Background Check Order
External Trigger Token
3

Save Configuration

Click Save button to save your webhook config.
External Trigger Token

​
ATS User Enablement

​
User Activation Flow

1

Obtain External Trigger Token

Users get the External Trigger Token from StackOne:
  1. Navigate to StackOne Connect Hub
  2. Copy the external trigger token
External Trigger Token
2

Access SmartRecruiters Marketplace

Customers access the SmartRecruiters Marketplace through:
  1. SmartRecruiters admin dashboard → Settings → Apps and Integrations
External Trigger Token
External Trigger Token
  1. Search for your integration by name
  2. Click on your integration tile to view details
3

Select Integration

Navigate to specific integration from the list of available integrations in SmartRecruiters account.
Select Integration
4

View Details

Review the integration details and click on Connect.
View Integration Details
5

Enable Integration

  1. Review permissions
  2. Click Allow and Continue button
External Trigger Token
6

Input external trigger token into form

Users will be presented with the input form to verify the external trigger token and email and click on Submit button:
External Trigger Token
7

Verify Connection

Once submitted credentials verified Successfully, user will see a message on the top right corner of the screen that says: StackOne Assessments is connected.
Integration Connected Successfully

​
ATS User Experience

​
Step-by-Step User Journey

This section covers how recruiters use the integration to send assessments or background checks to candidates: There are two types of assessments in SmartRecruiters - Candidate Assessments and Inline Assessments
1

Access Job Application

  1. User logs into SmartRecruiters
  2. Navigates to People
  3. Selects a specific candidate profile
User Configuration Form
2

Initiate Assessment/Background Check

From the candidate profile:
  1. Look for the assessment section
  2. Click Order Assessment button
Send Assessment Button
3

Select Package

In the assessment form:
  1. Select Assessment Partner: Select your assessment partner
  2. Select Package: Choose from available test packages
  3. Click Continue: Click on continue button
Package Selection Form
4

Send to Candidate

  1. Review the test details and candidate information
  2. Click Send button
  3. Candidate receives email notification with test link and instructions
Package Selection Form
5

Review Results

Recruiters can track progress:
  1. Status Updates: View real-time status in candidate profile (Sent, In Progress, Completed)
  2. View Attachments: Click to view detailed results within SmartRecruiters
Assessment Status Tracking

​
Complete User Workflow

The complete flow from activation to result review ensures recruiters have a seamless experience sending tests and viewing results directly within their familiar SmartRecruiters interface, without needing to switch between multiple platforms.

​
Payload to UI Mapping

The following table shows how different payload fields and conditions affect what users see in the SmartRecruiters UI when updating test results:
Payload Field/ConditionUsers see in SmartRecruiters UINotes/Comments
result = "COMPLETED"Green checkmark, “Assessment Complete” badgeShows successful completion status
result = "REJECTED"Red icon, “Assessment Failed” badgeIndicates test failure or rejection
result = "IN_PROGRESS"Yellow icon, “In Progress” badgeShows ongoing test status
result = "PENDING"Grey icon, “Pending” statusShows test has been pending
result = "EXPIRED"Yellow icon, “Expired” statusShows test has expired without completion
score.valueNumerical score displayed prominentlyRequired field for score display
score.min & score.maxScore range context (e.g., “75/100”)Required fields that define score boundaries
score.labelCustom score label or descriptionOptional descriptive label for the score
summarysummary sectionRich text summary of results
attachments[].url”Download Reports” section with file linksMultiple downloadable documents with type ‘OTHER_URL’
start_dateAssessment start timestampWhen the assessment was initiated
submission_dateCompletion timestampWhen the assessment was submitted

​
Troubleshooting

​
Common Issues and Solutions

SymptomLikely CauseFix
Integration not appearing in SmartRecruiters marketplacePartnership not approved or marketplace listing incompleteVerify partnership status in SmartRecruiters Partner Portal. Complete marketplace listing requirements.
”Send Assessment” button missing from candidate profileIntegration not properly activated or insufficient permissionsCheck integration status in SmartRecruiters Active Apps. Verify user has recruiter permissions.
Package list not loading or emptyPackages list endpoint returning errors or empty responseVerify endpoint URL in StackOne configuration. Check endpoint logs for errors. Ensure proper authentication.
External Trigger Token field is not visible at StackOne Connector HubSelected Authentication Type is incorrectSelect Authentication Type OAuth - Assessments/Background Checks instead
Test notification is not receivedInvalid webhook URLVerify webhook URL
Incorrect webhook events are enabled.Enable expected events as mentioned in the StackOne Configuration.
Unable to update resultInvalid payload formatCheck Connector Meta API endpoint for payload format
Result URL or Attachment’s URL showing error when opened.Added result URL can be expired or is private.Ensure to add public or signed URLs; verify CORS and expiry.
⌘I