Align Partner Guide
This guide is for companies that build on Align: integrations that call the Public API, receive webhooks, or are listed in the Align Marketplace.
What partners can do
- Call the Public API (v1). Read and write projects, entries, comments, releases, time entries, users and more over REST, with an API key.
- Receive webhooks. Align sends a signed HTTP
POSTto your URL when an event you subscribed to happens. - Retrieve release evidence. Fetch a structured evidence package for a release, optionally signed, for compliance records.
- List an app in the Align Marketplace. Publish an app that Align customers can install into their workspace.
Sections in this guide
| Section | What it covers |
|---|---|
| Apply | Applying to the partner programme and what approval gives you |
| API Keys | Creating, using and revoking API keys |
| Marketplace Listing | Creating an app, submitting it for review, and how customers install it |
| Release Evidence API | The evidence package and its signature |
| Webhooks | Subscriptions, delivery format, signatures, retries and the events Align sends |
| User Provisioning | Inviting and provisioning users through the API |
| Time Entry API | hours and minutes, the status lifecycle, approvals and filters |
| Reconciliation | Polling, pagination and checking integration links |
| Authorization & Scopes | Key scopes, permissions, role checks and error codes |
Support
For integration support, email support@alignsoft.us.