Current user must have Jira Permission to browse users and groups.
Three request headers must be set beforehand:
email - email address of the user, who will be accessing API
jira-host - address of Jira Cloud instance
api-token - token created by the user who will be accessing the API
Set Automation rule
Visit API Integration page for more details.
In order to set up the Automation rule for the project, proceed to Project settings → Automation → click Create rule.
Choose a trigger for the rule.
As an action select Send web request.
2.1. Enter Web request URL.
2.2. Enter headers: email, jira-host, api-token.
2.3. Select HTTP method: GET or POST.
2.4. Fill in Web request body if necessary.
2.5. Check the required boxes in Wait for response section:
- Delay execution of subsequent rule actions until we've received a response for this web request.
- Continue running the rule even if the request response is not successful (i.e. non-200 response).
Validate your web request configuration by entering an issue key (optional).
Click Save and select Turn it on.
Choose a trigger for the rule.
As an action select Send web request.
2.1. Enter Web request URL.
2.2. Enter headers: email, jira-host, api-token.
2.3. Select HTTP method: GET or POST.
2.4. Fill in Web request body if necessary.
2.5. Check the required boxes in Wait for response section:
- Delay execution of subsequent rule actions until we've received a response for this web request.
- Continue running the rule even if the request response is not successful (i.e. non-200 response).
Validate your web request configuration by entering an issue key (optional).
Click Save and select Turn it on.
Use Case example
When the issue is commented on, I want Secure field values to be sent to the administrators by email.
Steps to configure
Trigger
Go to Project settings → Automation → click Create rule.
Create a trigger: Issue commented.
Pick comment type → click Save.
Add Action 1
Add an action: Send web request.
Web request URL: https://eu-sfapp.almarise.com/integration/app/rest/api/v1/secure-field/value/10015
Headers: email, jira-host and api-token.
HTTP method: GET.
Web request body: Empty.
Wait for response: check the box for “Delay execution of subsequent rule actions until we've received a response for this web request.“
Click Save.
Add Action 2
Add an action: Send email.
To: administrators.
Enter the subject of the email.
Content: {{webResponse.body}}.
Click Save → Turn it on.