DEVELOPERS

Developer Documentation

Integrate OpsTicket assessments into your hiring workflow, ATS, or custom applications using our REST API and SDKs.

Full API Reference

REST API

The OpsTicket API follows REST conventions with JSON request and response bodies. All endpoints require authentication and return standard HTTP status codes.

$Base URL: https://api.tryopsticket.com/v1
$JSON request/response format
$Standard HTTP status codes
$Rate limited to 100 requests/minute

Authentication

API requests are authenticated using Bearer tokens. Generate API keys from your dashboard under Settings > API Keys. Keys are scoped to your organization.

$Bearer token authentication
$Organization-scoped API keys
$Key rotation without downtime
$Test and production key separation

Core Endpoints

Manage assessments, candidates, and results programmatically. The API supports creating assessments, inviting candidates, retrieving scores, and exporting reports.

$POST /assessments - Create assessments
$POST /invitations - Invite candidates
$GET /results/:id - Retrieve scores
$GET /reports - Export reports

Webhooks

Receive real-time notifications when events occur in your OpsTicket account. Configure webhook endpoints from your dashboard to subscribe to assessment and candidate events.

$assessment.completed
$candidate.invited
$candidate.started
$score.available

SDKs

Node.js

npm install @opsticket/sdk

Python

pip install opsticket

Go

go get github.com/opsticket/sdk-go

Ready to Integrate?

Get your API key from the dashboard and start building. Our team is available for integration support.

API ReferenceDeveloper Support