Skip to main content

​
Overview

Ropes provides a webhook integration that automatically sends assessment results to your systems when a candidate completes a coding test. This allows you to integrate Ropes seamlessly with your existing recruitment workflow and tools.

​
When Does the Webhook Trigger?

The webhook triggers automatically when:
  • A candidate completes a coding assessment
  • The system has finished evaluating the candidate’s code
  • A final score has been calculated

​
Webhook Payload

When triggered, the webhook sends a POST request to your specified endpoint with the following JSON payload: 
{
  "codeScore": 85,                                      // Numeric score for code quality
  "completionDate": "2023-06-15T14:30:45.123Z",        // ISO timestamp when assessment was completed
  "finalScore": 85,                                     // Overall assessment score
  "plagiarism": false,                                  // Whether plagiarism was detected
  "reportLink": "https://yourdomain.ropes.ai/results/interview-id", // Link to full assessment report
  "status": "Completed",                                // Assessment status
  "testId": "123",                                      // ID of the problem/test
  "testName": "Backend Developer Assessment",           // Name of the problem/test
  "timeTaken": 1800,                                    // Time taken in seconds
  "email": "candidate@example.com"                      // Candidate's email address
}

​
Security

For security, each webhook request includes a signature in the x-ropes-webhook-signature header. This signature is generated using HMAC-SHA256 with your webhook secret key and the request payload. To verify the authenticity of webhook requests:
  1. Use the same secret key to generate an HMAC-SHA256 signature of the received payload
  2. Compare this signature with the one in the x-ropes-webhook-signature header
  3. Only process the webhook if the signatures match

​
Setting Up the Webhook

To configure the webhook integration:
  1. Navigate to the Integrations page in your Ropes dashboard
  2. Scroll to the Webhook section
  3. Enter your webhook endpoint URL (must be HTTPS)
  4. Generate and enter a secure webhook secret key
  5. Click “Save”
⌘I