Autodesk Forma Issues API now supports more Webhook events, making it easier to build integrations that stay up to date with changes to issues and their related objects. In previous versions, the Issues API provided webhook events for issue creation, updates, and deletion etc. With this release, webhook support is extended to changes to objects associated with an issue, including comments and attachments.
These new events are currently available as Public Beta.
New Webhook Events
The following webhook events are now available for issues:
- comment.created-1.0 — Triggered when a comment is created on an issue.
- attachment.created-1.0 — Triggered when an attachment is added to an issue.
- attachment.deleted-1.0 — Triggered when an attachment is deleted from an issue.
These events work in the same way as the existing Issues webhook events. You can subscribe to them using the Webhooks API and receive notifications when the corresponding changes occur. For a walkthrough of how to use Issues webhooks, see our previous blog post: Webhooks API for ACC Issues is Released.
Get the IDs You Need for Further Integration
When one of these events is triggered, the webhook callback payload provides the identifiers needed to retrieve additional data and integrate the event into your application. The callback includes:
- Project ID
- Issue ID
- Comment ID or Attachment ID, depending on the event
For example, when a comment is created, your application can use the Project ID, Issue ID, and Comment ID from the webhook notification to retrieve the corresponding comment and perform further processing. This allows you to build event-driven workflows without continuously polling the Issues API for changes.
Supported Forma Regions
These new events support the regions currently available for Forma APIs. When working with the Webhooks API, make sure to specify the appropriate region header when creating or managing your webhook subscriptions. Using the correct region ensures that your webhook subscription is associated with the intended Forma region.
Try It with an AI-Generated Sample
To make it easier to explore these capabilities, we also created a sample application using GitHub Copilot.
https://github.com/autodesk-platform-services/aps-forma-issues-webhooks-nodejs
The sample demonstrates how to subscribe to Issue webhook events, unsubscribe from webhook events, receive and inspect webhook notifications
work with the IDs included in the event payload. The sample provides a practical way to see how these new events can be used to build integrations around Issues.
Issue Attachment Limit Increased
As part of this release, we also increased the maximum number of attachments that can be associated with an issue. Previously, an issue could have up to 100 attachments. The limit is now increased to 200 attachments. If an application attempts to add more attachments than the supported limit, the API returns: 422 Unprocessable Entity
This change provides additional capacity for projects where issues need to include a larger number of supporting files.
For more information, please check the documentation of Webhook API.