Workflow XML Reference - Action Properties
6 min
the following lists the parameters that can or must be included when defining a triggered action triggered action emailnotificationaction properties property requirement notes emails or propertyname required sends a message to the specified users about the action users are specified either as individual email addresses or a user group name contains the following child element structure \<propertyname> name of the user group \</propertyname> \<message> message sent to recipients \</message> or \<emails> \<email> email address 1 \</email> \<email> email address 2 \</email> \<email> email address n \</email> \</emails> \<message> message sent to recipients \</message> message required the message sent to specified users about the action triggered action propertychangeaction properties property requirement notes propertyname required the name of the standard artifact property that is changing propertyvalue applies to one of the following standard artifact types text, number, and date replaces the existing value contains the following child element structure \<propertyname> name of standard artifact property \</propertyname> \<propertyvalue> its new value \</propertyvalue> date format can be one of the following yyyy mm dd 0 (the date of the property change) a non zero integer that adds or subtracts the number of days from the current date (for example, " 7" is a week before the property change) clears the property value if entered as an empty element (\<propertyvalue />) validvalues one of these three properties (propertyvalue, validvalues, usersgroups) is required only one instance of these properties can be used in any given \<propertychangeaction> block in the xml applies to the "choice" standard artifact type (single, or multi choice) replaces the existing set of choices contains the following child element structure \<validvalue> \<value> newvalue1 \</value> \</validvalue> \<validvalue> \<value> newvalue2 \</value> \</validvalue> \<validvalue> \<value> newvaluen \</value> \</validvalue> usersgroups applies to the "user" standard artifact type updates a user type property with the defined users, and instance and project level groups contains the following child element structure \<usergroup> \<name> username \</name> \</usergroup> \<usergroup isgroup="true"> \<name> instance level group name \</name> \<groupprojectid> \<usergroup isgroup="true"> \<name> project level group name \</name> \<groupprojectid> projectidnumber \</groupprojectid> \</usergroup> \<usergroup isgroup="true"> \<name> project level group name \</name> \<groupprojectpath> blueprint/folder/project1 \</groupprojectpath> \</usergroup> when the isgroup="true" attribute and value are used, the name is interpreted as a group, not an individual user when the isgroup attribute is used, and the groupprojectid or groupprojectpath child elements are also included, the name is interpreted as a project level user group; otherwise, it is an identically named instance level group if the includecurrentuser="true" attribute and value are included with the parent usersgroups element, the current user (who has triggered the property change) is also included in the property change note username declarations are case sensitive triggered action webhook action properties property requirement notes url required the payload will be sent to this address if the action is triggered ignoreinvalidsslcertificate optional false by default controls whether the webhook should ignore an invalid ssl certificate accepted values true and false httpheaders optional the call to the specified url will include these headers headers can be used to include additional information when sending the webhook contains the following child element structure \<httpheaders> \<header>name1\ value1\</header> \<header>name2\ value2\</header> \</httpheaders> basicauth optional if a username and password are specified, they are included here contains the following child element structure \<basicauth> \<username>admin user\</username> \<password>$ecr3tp\@ssw0rd\</password> \</basicauth> must be listed before \<signature> if both elements are provided signature optional has two child elements \<secrettoken> (required) and \<algorithm> (optional) accepted values for \<algorithm> are hmacsha256 and hmacsha1 if \<algorithm> value not provided, defaults to hmacsha256 must be listed after \<basicauth> if both elements are provided triggered action generateactiontype (value is "children") properties property requirement notes childcount required the number of child artifacts that are created contains the following child element structure \<generateactiontype>children\</generateactiontype> \<childcount> number to create \</childcount> \<artifacttype> standard artifact type \</artifacttype> artifacttype required the type of standard artifact that is automatically created triggered action generateactiontype (value is "testcases") properties property requirement notes contains the following child element \<generateactiontype>testcases\</generateactiontype> triggered action generateactiontype (value is "userstories") properties property requirement notes contains the following child element \<generateactiontype>userstories\</generateactiontype>