Documentation on Jira automation, webhookData

[Bill Sheboy]

Greetings, community!

The problem I am trying to solve: create Jira project-level automation rules based upon when issues have been released (with a version), and the existing automation documentation is insufficient to support that.

Where might I find documentation on Jira automation values supplied as webhookData?

I am specifically looking for a complete listing of:

• What webhookData is returned for the each of the different triggering events
• What each webhookData contains.  Note, this is not the same as the values/types in the issues, as the names and contents are different, such as for versions.

Thanks!

[Elad Ben-Noam]

Hi @Bill Sheboy

I think that you'll find my presentation pretty helpful to begin with: https://bit.ly/2VKW7TD

Regarding the content, the trigger catches the issue that was changed and triggered the automation rule (with all its fields). 

All the actions are relating the same issue, unless you use the "branch rule".

I agree that the documentation is not complete but it has many useful examples to what you can achieve: https://support.atlassian.com/jira-software-cloud/docs/automate-your-jira-cloud-processes-and-workflows/

[Bill Sheboy]

Hi @Elad Ben-Noam 

Thanks for your response.  I have already reviewed the article you linked and provided some feedback on it.  For example, there are supporting links to Oracle functions that do not match the behavior of the same functions within smart value processing.  It is unclear if they were just provided for context or meant to be the same.

Regarding your comment that the trigger catches and passes on all of the data, that is not entirely correct.  For example, things like released versions: all of the version's data is not forwarded with the webhook.  Instead only the name appears to be passed, although it is not parse-able in the same manner as when version is extracted from an issue.

I hoping one of the staff from the acquired company (Code Barrel) will comment on this question.  The original knowledge store from their Confluence page has been deprecated.  Maybe they have more information on the webhookData contents.

[Elad Ben-Noam]

@Bill Sheboy 

Sorry for misleading you.

I haven't used the web request so far but I guess you can add the following if you change the "Webhook body" to custom:

{{triggerIssue.fixversions.name}}

{{triggerIssue.fixversions.id}} 

{{triggerIssue.fixversions.self}} 

{{triggerIssue.fixversions.description}} 

{{triggerIssue.fixversions.archived}} 

{{triggerIssue.fixversions.released}} 

{{triggerIssue.fixversions.releaseDate}} 

I hope it helps.

[Bill Sheboy]

Thanks, @Elad Ben-Noam   And, no worries as you are helping to answer the questions.

As a reminder, when a version is released it is the triggering entity, not a specific issue like a story, bug, etc..  This is why I was looking for more documentation, as the data provided with this trigger's webhook is somehow different, and appears to contain only something that looks like the name attribute.

One challenge of diagnosing issues with the automation is terse error messages.  Code Barrel had improving those in their backlog prior to the acquisition, so let's hope they get worked on sooner rather than later.  :^)