Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Clarified escaping requirements for variables.

...

Excerpt


Tip
titleJSON escaping requirements

If a parameter within the JSON formatted parameters template is a JSON structure in itself (e.g. the Lambda function payload), it needs to be escaped before adding it as a value - this has two implications:

  • (tick) custom content needs to be escaped, which can be achieved by Composing action payloads with utility functions, specifically the $util.escapeJson() function
  • (error) variables (warning) variables with conflicting content (notably e.g. multi line variables like JIRA's $issue.fields.description or Bamboo's $notification.textEmailContent) can not currently be used in this context (while all variables are escaped by default, they need to be escaped again when used within an already nested JSON structure) - this will be addressed in a near textEmailContent or JSON structures retrieved via JSONPath) need to be escaped twice, via $util.escapeJson($util.escapeJson(...)) - we are exploring options on how to make this easier in a future release