Use case: Approval start upon transition

This document will guide you to automatically start Approval Path on any work item that will go through a particular status transition.
This will help you skip the hassle of manually starting the approval on every single work item.

Use case

There is a particular approval that is required for every single work item created in a space. When a work item is created, in the “backlog status”, it must be approved before being transitioned to the “In progress” status.
We can add a third status, “Waiting for approval,” and use this status as a trigger to initiate the approval path.

Therefore, any work item that will transition to this status will start the approval path.

Pre-conditions

1. Have the status you wish to use as the trigger (for example: Waiting for approval)

2. Create an API key Documentation

3. Make sure the “Create” Approval privilege is granted

Open

Automation steps

1. Navigate to the space settings

2. Select the “Automation” tab

3. Click on the “Create rule “ button → “Create from scratch”
   
   

Open

4. Search for the “Work item transitioned” trigger

5. Select the trigger

6. There are two fields of “From status” and “To status”; select which status change should trigger the action to be taken, in this case. (For example: In progress -> Done)
   
   

   Open

   

7. Click on the “Next” button

8. Click on the “THEN: Add an action” button
   
   

   Open

   

9. Search for “Send web request” action type

10. Select the action
    
    

    Open

    

    1. Fill in the data
       
       

       Open

       

       1. Web request URL https://app.approval-path.com/webapi/approvals/{{issue.key}}

       2. HTTP method POST

       3. Web request body Custom data

       4. Custom data

          { "definitionId": "id of approval definition you want to start", "summary": "Demo transition trigger" }

          *Definition ID can be obtained from the definition page
          
          

          Open

          

           

       5. Headers

          1. Authorization

          2. Bearer + your API key value (for example: 4mbmqXaw4cATK9BMXblqFiD6ei3q4vSdsYVGQ9CKFsrf)

11. Click on the “Turn on rule” button

12. Select a name for this Rule

13. That is all!

Now, whenever the issue is transitioned, the approval path will start automatically.

Here is a sample result, where after changing the work item status from “Backlog” to “Waiting for approval”, an approval definition named “Here is an approval definition” is started automatically:

Open