Webhook step
With the webhook step, you can introduce automation to your approval process management. You can place the webhook step at any place in the approval path.
Webhooks allow you to establish communication between Approval Path and external applications - for example, Jira, GitHub, Salesforce, or your own custom apps that support webhooks. They enable Approval Path to send real-time data to these systems when a webhook step is triggered in the approval flow, making it possible to integrate and automate workflows across platforms.
Example Jira actions that can be triggered using a webhook step:
Transition a work item to another status
Update work item fields (e.g., status, priority, assignee)
Add a comment to the work item
For example, by using a webhook step at the beginning of the definition that triggers a Jira endpoint, you can prepare the work item for the approval process. If placed at the end, the webhook can be used to, for example, transition the work item to the next phase.
A webhook involves an HTTP call where you need to specify a URL and method (GET/PUT/POST/DELETE). Additionally, it's optional to specify an HTTP body and headers.
We have introduced Automation Step, which makes the most popular Jira automations like changing work item status, adding/removing labels, or adding a comment much simpler, without the need to create webhooks.
Check out: Automation step
Approval Smart Values
Inside the URL, headers, and body, you can use dynamic values:
You have to put names inside ${…}
Name |
Description |
|---|---|
|
Space id |
|
Work item id |
|
Approval name |
|
Approval id |
Action Type
Each webhook step in the approval process has an Action Type that defines how the response from the webhook is interpreted. There are three available action types:
Approval and Consent
These types expect the webhook to return a successful HTTP status code (200–299).
If the response code is in the 200–299 range:
→ The step is marked as Approved.❌ If the response is outside this range or the call fails:
→ The step is marked as Rejected.
Use these types when an external system or check needs to approve or deny part of the process (e.g., verifying if a condition is met before proceeding).
Notification
This type always results in an Approved step, regardless of the webhook response.
Even if the server returns an error or is unreachable, the step will still be marked Approved.
Work item watchers notification
This feature gives an effective way to update notifications for approval paths sent to work item watchers. It grants the user the ability to prevent unnecessary notifications, enhancing overall communication efficiency.
Create a step condition
To implement a specific step into the approval process based on a predefined condition in a Jira expression, use the 'Create Step Condition' feature. Once a condition from Jira Expressions is selected, the step becomes part of the approval workflow only when the condition is met. If the condition is not fulfilled or encounters an error, the step is excluded from the approval process. Refer to our documentation for comprehensive details on conditions.
Label condition
The Label condition determines whether this approval step is included in the approval path based on the labels assigned to the work item.
When configured, this step will only be added to the approval path if the defined label criteria are met. You can specify that:
The work item must include one or more specific label(s), AND/OR
The work item must not include one or more specific label(s)
If the work item satisfies the configured label condition, the approval step is automatically introduced into the approval path. If the condition is not met, the step is skipped.