Build against the contracts Connect ships today.

Browse by job to be done

Every published guide is listed once. Start with the workflow you need, then validate the final request in OpenAPI.

All 31 guides

31 of 31 guides

• Connect workspace navigationFind tasks in the Allure Connect workspace, copy your workspace ID and API key, check LIVE vs TEST mode, and understand permissions.
• REST API overviewThe Allure Connect REST API: quick start, authentication, rate limits, endpoints, error handling, best practices, SDKs and tools.
• API versioning policyAllure Connect API contracts and compatibility policy: V1 endpoint families, what Create V2 means, and how rollout and rollback work.
• Allure Create publishing V1 and V2Which Allure Create publishing version to use with Allure Connect, what V2 adds (signed authorisation, receipts) and how V1 and V2 coexist.
• GPT Actions setupSet up a custom GPT with the Allure Connect GPT Actions schema: setup steps, available actions, example instructions and the schema URL.
• MCP server status (preview)Preview of the Allure Connect MCP server: planned tools and preview setup for Claude Desktop and Claude Code. The npm package is not published yet.
• Publish a SCORM course via REST APICreate a sandbox workspace, publish structured content as a hosted SCORM course with one REST call, and verify activation.
• SCORM API documentationIndex of the Allure Connect SCORM API docs: getting started, dispatch and integration guides, security and operations, reference and troubleshooting.
• SCORM API quick startSign up, get an API key, test your connection and upload your first SCORM package to Allure Connect in four steps.
• Upload your first SCORM packageUpload a SCORM 1.2 or 2004 package to Allure Connect: package requirements, upload methods, the response, package management and fixes.
• Launch your first SCORM sessionCreate a SCORM session, launch the hosted player, track progress and update session data with the Allure Connect API.
• Generate your first learner reportChoose a reporting surface, view learner progress in the dashboard, export it, build custom reports and use Partner API reporting.
• SCORM CMI data guideWhat SCORM CMI data is, how Allure Connect stores, reads and updates it, the key CMI elements and how to troubleshoot them.
• SCORM dispatch overviewWhat dispatch packages are, how they launch your hosted course from a customer LMS, the architecture, benefits and use cases.
• Create a dispatch packageCreate an Allure Connect dispatch package in the dashboard or by API, set its configuration options and download the package.
• Distribute dispatch packagesDistribute dispatch packages to customer LMSs, monitor distributions and manage updates centrally, with troubleshooting tips.
• Build a learning app on ConnectBuild on Allure Connect: configure a public API key, deliver a course, connect learning evidence to skills, and see the current contract scope.
• Custom LMS integrationIntegrate Allure Connect with a custom LMS: architecture, implementation steps, code examples, UI components and data synchronisation.
• Allure Training OS integrationIntegrate Allure Training OS with Allure Connect: prerequisites, setup, core integration, error handling and a production checklist.
• WordPress integration guideDeliver Allure Connect courses on WordPress: plugin setup, shortcodes, admin screens and user progress tracking, with a complete example.
• API key securityCreate, scope, send, store, rotate and revoke Allure Connect API keys, understand LIVE vs TEST keys, and follow the incident checklist.
• Security overviewHow Allure Connect secures the platform: architecture, authentication methods, data protection, network security, compliance and incident response.
• API rate limitsAllure Connect Partner API rate limits, response headers and a client retry pattern, and why backend failures differ from rate limiting.
• Webhook setupSet up Allure Connect webhooks: register an endpoint, choose events, secure and test deliveries, and troubleshoot failures.
• Webhook events referenceAllure Connect webhook event types, delivery guarantees, retry logic and idempotency, with best practices for handlers.
• Webhook signature verificationSecure Allure Connect webhooks: signature verification, HTTPS, secret management, rate limiting and common vulnerabilities, with a checklist.
• SCORM API referenceReference for the Allure Connect SCORM API: authentication, base URLs, versioning, rate limits, errors and every endpoint with examples.
• API error codesAllure Connect API error codes for authentication, validation, packages, sessions, dispatches, webhooks and xAPI, and how to handle them.
• SCORM API code examplesAllure Connect API code examples: a quick start, common use cases, framework examples and testing patterns.
• SCORM troubleshooting: common issuesFix common Allure Connect problems: authentication, package upload, sessions, the hosted player, API errors and performance.
• WordPress SCORM & xAPI pluginThe Allure Connect SCORM and xAPI plugin for WordPress: install and update, upload packages, embed content and use REST for mobile apps.

Machine-readable contracts

• OpenAPI JSON /api/docs/openapi
• Connect v1 contracts /api/v1/contracts
• Docs contracts inventory /api/docs/contracts
• GPT Actions schema app/api/v1/openapi-actions

Product updates

• v2026.10.1 · October 10, 2026 · Fixed

  If you belong to several workspaces and switch workspace in one browser tab, your other open tabs now say so and ask you to reload or switch back. A change submitted from a tab that still shows the previous workspace is refused, with nothing saved. A bulk dispatch action now changes every dispatch you selected or none. Reading pages is not affected, and neither are API keys, xAPI credentials or learner launch links.

• v2026.10.1 · October 10, 2026 · Added

  A reviewer can now say how the skill is demonstrated and how much it demands. The highest level a score can prove is worked out from those answers. Content with nothing set is scored as before. API: demandRatings, demonstrationMode, passMarkScaled; GET /api/v1/capability/evidence-framework, PUT /api/v1/capability/mappings/{mappingId}/evidence-attributes.

• v2026.10.0 · October 9, 2026 · Changed

  Uploading a course, the SCORM validator, Quick Publish, test launches, opening a learner session from the Player page and recording a VR outcome are now for workspace owners and admins. Other roles still see courses, delivery and reports. With several workspaces, these work in your active workspace only. API keys and learner launch links are not affected.