Align Partner Guide
Welcome to the Align Partner Programme. This guide covers everything you need to integrate with the Align platform, publish your integration to the Align Marketplace, and use the Developer API.
What Partners Can Do
As an Align partner your organisation can:
- Access the Public API — read and write project data, entries, releases, users, and more via the REST API.
- Subscribe to webhooks — receive real-time event notifications when things change in Align.
- Retrieve release evidence — pull signed evidence packages for releases to feed compliance workflows (e.g. the Smartshares audit trail requirement).
- List on the Align Marketplace — publish your integration so Align customers can discover and install it.
Sections in This Guide
| Section | What it covers |
|---|---|
| Apply | How to apply for partner status |
| API Key | Minting and managing your API key |
| Authorization & Scopes | Key scopes, role requirements, and endpoint permission matrix |
| Marketplace Listing | Publishing your integration |
| Release Evidence API | Retrieving signed release evidence |
| Webhooks | Subscribing to and verifying Align events, recommended event set |
| User Provisioning | Inviting users via API — role defaults, enum values, and role effects |
| Time Entry API | hours vs minutes field semantics, status lifecycle, and filtering |
| Reconciliation | Polling endpoints, pagination model, and integration-link verification |
Support
For integration support, contact us at dev@alignsoft.us or open a thread in the partner Slack channel.