RFCs are a way for Atlassian to share what we’re working on with our valued developer community.
It’s a document for building shared understanding of a topic. It expresses a technical solution, but can also communicate how it should be built or even document standards. The most important aspect of an RFC is that a written specification facilitates feedback and drives consensus. It is not a tool for approving or committing to ideas, but more so a collaborative practice to shape an idea and to find serious flaws early.
Please respect our community guidelines: keep it welcoming and safe by commenting on the idea not the people (especially the author); keep it tidy by keeping on topic; empower the community by keeping comments constructive. Thanks!
Project Summary
We are currently investigating the possibility of releasing some public REST APIs to help manage automation rules in Atlassian Automation to facilitate easier management of large volumes of automation rules and seamless integration for apps with the Automation. We would greatly appreciate your input on the use cases you envision for the APIs listed on the page, as well as any suggestions for new API endpoints that could be developed to support your current and future applications.
- Publish: Jun 6, 2025
- Discuss: Jun 23, 2025
- Resolve: Jun 30, 2025
Problem
In the past, we have released several public APIs to facilitate interaction with Automation rules; however, these APIs are currently not accessible to Forge and OAuth2 apps. We are actively working to enhance our public API offerings by introducing new endpoints (listed below) specifically for our high-usage Automation customers.
In conjunction with Action (EAP), we are exploring ways to improve the integration capabilities of applications with the Automation Platform and making these API endpoints available for Forge and OAuth2 applications presents a significant opportunity.
Proposed Solution
Our current plan is to enable following operations through REST APIs:
- Retrieve list of all automation rules: Get details about all the rules in your site/project/container
- Retrieve a list of automation rules: Get details about all the rules in your site/project/container, based on trigger, state, scope.
- Fetch details of a specific rule: Drill down into specific components to all of its metadata, enable/disable status, projects associated, status, etc.,
- Make component level edit to the rule
- Import an exported rule to a different site
- Import an exported rule to the same site
- Enable/Disable rules
- Associate and disassociate project from a rule
Asks
While we would appreciate any reactions you have to this RFC (even if it’s simply giving it a supportive “Agree, no serious flaws”), we’re especially interested in learning more about the following:
- Do you think you will be using these APIs to integrate your apps with Atlassian Automation?
- What use cases do you believe these APIs will enable for your apps, both now and in the future?
- Are there any additional operations you would like to see added to the list provided above?
3 Likes
Hi,
this looks pretty nice.
- Import an exported rule to a different site
- Import an exported rule to the same site
So we could use this if our app would need specific automations, right?
In the sense of we create the rule by hand, export it, and then our app imports it.
Could you also consider allowing to create rules programmatically without the need to export a rule first?
An API endpoint to create new rules directly (without first manually creating and exporting them) could be valuable for dynamic or generated rule scenarios in apps.
Best regards,
Christopher
4 Likes
Thanks for working on this.
When comes to the APIs, would you also consider exporting a rule?
I see you want to support 2 import APIs but I on’t see the export API listed here, or on the linked public API docs.
1 Like
We would definitely use this API!
One important way for us to use it: if we can develop automation actions in Forge, then we would probably ship our actions with a few demo rules created using this API.
I see two important use cases not listed above:
- Search for rules by labels
- Run rules (of course only those that can be run “manually”, e.g. the ones with the “Periodic trigger”)
1 Like
We are also interested in this. Our use case is similar to @aron.gombas’s: We want to build our own Automation Action, and like to make it as easy as possible for our customer to use these rules. Currently, we have documentation about how to manually build a rule with standard Automation building blocks. We want to improve it – from customer’s perspective: simplify it – by having a 1-click solution (or close to that) that creates an Automation rule containing our custom Automation action (amongst other things).
The APIs of this RFC would make that possible, I think.
(@aron.gombas, running a manual rule is part of the existing set of REST endpoints. Therefore not listed in the set of new endpoints, I guess)
1 Like
The following operations would also be necessary:
- Fetch audit logs for a specific rule
- Fetch audit log details for a specific audit log
- Generate webhook token for the Incoming webhook trigger
- Create rule
- Get rule labels
- Create rule label
3 Likes
Actually, we’d like to add our own entries into “Templates”:
I think, that would be the ideal way for our customers to find and use our pre-built Automation rules. Any plans for supported that for (Forge) apps?
3 Likes
@AndreasEbert Oh, I missed the endpoint that allows running rules. Thanks!
Q1: Do you think you will be using these APIs to integrate your apps with Atlassian Automation?
A1: Yes, we would definitely leverage these API’s when available.
Q2: What use cases do you believe these APIs will enable for your apps, both now and in the future?
A2: The ideal use case would be to backup our automations and restore them if required (automation flows are a critical piece of business flows)
Q3: Are there any additional operations you would like to see added to the list provided above?
A3: The ability to create automations via the REST API so we can restore them in the case they are accidentally deleted or broken. The list above mentions ‘import’ (maybe that covers this use case), but it’s not immediately clear based on the description.
“Fetch details of a specific rule” – if the details included when a rule was last updated, that would be very helpful as well!
Hello there,
First of all, thank you for sharing the RFC.
Currently, none of our apps use Automation via API, but we do see great potential in offering customers a set of predefined Automation rules as part of the experience.
We’ve already included some of these rules in our app documentation so users can set them up manually, but being able to create them programmatically, beyond just using templates, would be a valuable improvement for us.
Since our main app is highly related to projects, the endpoints related to associating or disassociating projects with rules, as described in the RFC, would also be particularly relevant for our use case.
