Developer Documentation

API & WebhooksIntegration Guide

Integrate Assessly into your workflow with our REST API and real-time webhooks. Perfect for ATS, CRM, and custom application integrations.

API Access Required

API access is not available on the Free plan. Upgrade to Starter plan or higher to access the API and webhooks. All paid plans include API access with rate limits based on your plan tier.

REST API

Access submission data programmatically with our RESTful API. Fetch submissions, retrieve responses, and integrate with your existing systems.

  • List and filter submissions
  • Get detailed submission data
  • Secure API key authentication
  • Rate limiting protection

Webhooks

Receive real-time notifications when submissions are created or updated. Perfect for triggering workflows in your application.

  • Real-time event notifications
  • Automatic retry on failures
  • Secure signature verification
  • Filter by event types

Quick Start

1

Create API Key

Navigate to Dashboard → Settings → Integrations and create your API key. Copy it immediately as it will only be shown once.

sk_live_abc123...
2

Make API Request

Use your API key in the Authorization header to fetch submission data.

curl -H "Authorization: Bearer sk_..." \ https://assessly.app/api/v1/submissions
3

Setup Webhook

Register your endpoint URL to receive real-time notifications.

POST /webhooks/endpoints

Authentication

API Key Format

API keys follow the format: sk_live_<random_string>

Include your API key in the Authorization header:

javascript
const response = await fetch('https://assessly.app/api/v1/submissions?assessment_id=abc123&page=1&limit=50', {
method: 'GET',
headers: {
'Authorization': 'Bearer sk_live_abc123...',
'Content-Type': 'application/json'
}
});
const data = await response.json();
console.log(data);

Scopes & Permissions

ScopeDescription
submissions.readRead submission data (default)
submissions.writeCreate and update submissions
assessments.readRead assessment data and configurations
assessments.writeCreate, update, and delete assessments
webhooks.readView webhook configurations
webhooks.writeCreate and manage webhooks

Rate Limits

PlanRequests/Hour
Starter500
Pro2,000
Business5,000
EnterpriseCustom

API access is not available on the Free plan.

API Reference

Webhooks

Ready to Integrate?

Start building with our API today. Upgrade to a paid plan to access the API and create your API key in the dashboard.

API Documentation - Webhooks & REST API | Assessly Integrations | Assessly