RepScout API Assignments Framework

RepScout's Assignments framework allows third-party providers to integrate RepScout assignments into their platform.

This enables partners to initiate interviews, skills tests, and other assignments from the click of a button on their own third-party applications.

Overview

The Assignments API has two parts:

1. The API implemented by RepScout
2. The API implemented by the integration partner

General Flow

1. A Partner decides which assignment to send out.

   • Partner calls '/assignment.list' (RepScout API) to fetch available assignments.

2. The partner calls the RepScout API to trigger the assignment.

   • Partner calls '/assignment.start' (RepScout API) to trigger the assignment.

3. As the assignment progresses, the RepScout sends updates back to the partner.

   • RepScout calls '/assignment.update' (Partner API) to receive status updates.

4. At any time, the partner's user may cancel the assignment.

   • Partner calls '/assignment.cancel' (RepScout API) to cancel the assignment.

What RepScout Implements

GET /assignment.list

Purpose: List available assignment types.

• Called when a partner wants to present assignment options.
• This provides an ID reference to all the configured assignment types.

POST /assignment.start

Purpose: Start an assignment.

• Called by the partner when starting an assignment.
• Use the assignment type id to indicate which assignment type to use.

GET /assignment.status

Purpose: Manually get the status of an assignment - we recommend using the Webhook instead.

• Called by the partner when manually getting the status of an assignment.
• Use the assignment id to indicate which assignment to get the status of.

POST /assignment.cancel

Purpose: Cancel an ongoing assignment.

• Called by the partner if a customer opts to cancel an assignment.
• Use the assignment id to indicate which assignment to cancel.

What the Partner Implements

Partners must expose the following endpoints that will be called by RepScout:

POST /assignment.update

Purpose: As updates occur, RepScout will call this endpoint to notify the partner with the latest status and details for a started assignment.

• Partners will need to authenticate requests using the encoded api key provided.
• Requests must be sent over https.
• The base url for the Partner's API will need to be provided to the RepScout team as part of the onboarding process.

To learn more about the our API schema, view our API documentation.

API Documentation

View our API documentation

View our Sample App