In this page

How to generate PDF documents from Jira and send them in email?

Automatically generating PDF files and sending them as email attachments to one or more recipients is an efficient way to keep your stakeholders informed about Jira issues.

You can implement this process by configuring a simple automation rule:

Every time the rule is executed, recipients will receive an email with the PDF file attached:

To have this in minutes, just follow the step-by-step guides in the next sections!

Notes:

  • Although the guides are written specifically for the Scheduled and the Issue Event (created, updated, etc.) triggers, you can choose any other trigger!
  • Although the guides are written to implement the "bare minimum" rules, you can freely add further actions or conditions for altered logic!
  • The email with the PDF file attachment is sent from the "no-reply@jpdfc.midori.systems" address. This is a verified email address and cannot be changed due to security reasons.

Send PDF documents in email from a JQL query on a specified schedule

Watch this short tutorial video, then follow the detailed steps under the video:

Email Jira filter results on schedule in PDF
Email Jira filter results on schedule in PDF

Configuration steps:

  1. Login to Jira as administrator.
  2. Go to Settings (cog icon "⚙" in the top right) → System (under Jira settings) → Global automation (in the left-bar under Automation).
  3. Click Create rule.
  4. Select the Scheduled trigger and configure the schedule. (Do not check Run a JQL search... as the JQL query will be configured via the next action.)
  5. Click Next → THEN: Add an action.
  6. Select the Send web request action and:
    1. Enter "https://jpdfc.midori.systems/rest/v1/automation" as Web request URL.
    2. Select POST as HTTP method.
    3. Select Custom data as Web request body.
    4. Copy this request body template to Custom data: 
      client: {{rule.name}}
export:
  view: PDF
  viewContext: ISSUE_NAVIGATOR
  jql: project = FOO and created > startOfDay()  # set your JQL query
  columnConfiguration: USER_DEFAULT
actions:
  - name: Send PDF as email attachment
    type: SEND
    to: [ alice@acme.com, bob@acme.com, cecil@acme.com ]  # set your recipients
    cc: [ david@acme.com ]  # set or remove this line
    bcc: [ emily@acme.com ]  # set or remove this line
    subject: Project FOO stand-up report on {{now.jiraDate}}  # set your email subject
    body: Find the <b>PDF file</b> attached to this email.<br>  # set your email body
          Happy reading!
  - name: Call back to Jira Cloud Automation
    type: CALL
    url: https://automation.atlassian.com/pro/hooks/123450abcde  # set your callback rule's URL
    5. Set the actual values for the fields marked with # set ...:
      1. For the fields in the export: section:
        1. Open a new browser tab and generate the YAML fragment.
        2. Overwrite the whole export: section with the generated one.
      2. For the fields in the actions: section:
        1. At the SEND action, set the recipients, email subject and body (help).
        2. At the CALL action, set the callback rule's URL (help).
    6. Make sure that the indentation still looks like above after your changes. (Wrong indentation will break the request body!)
    7. Check the Delay execution of subsequent rule actions... option. (Needed for the next action to be able to write the ID received in the response to the log.)
    8. Add the required request headers to Headers.
  7. Click Next → THEN: Add an action.
  8. Select the Log action (not Log work!) and copy this to Log message: 
    PDF automation started. (ID: {{webResponse.body.messageId}})
  9. For self-verification, compare the rule in the editor to this screenshot. (They must contain the same components in the same layout, but identifiers can be different.)
  10. Click Turn on rule at the top.
  11. Enter "Send PDF on a specified schedule" to Rule name. (You can use any name as long as it is intuitive.)
  12. Click Turn on rule again → Return to rules.
  13. You're done!

Send PDF documents in email on issue events (created, updated, commented, etc.)

Watch this short tutorial video, then follow the detailed steps under the video:

Email Jira issue when done in PDF
Email Jira issue when done in PDF

Configuration steps:

  1. Login to Jira as administrator.
  2. Go to Settings (cog icon "⚙" in the top right) → System (under Jira settings) → Global automation (in the left-bar under Automation).
  3. Click Create rule.
  4. Select any of the Issue triggers.
  5. Click Next → THEN: Add an action.
  6. Select the Send web request action and:
    1. Enter "https://jpdfc.midori.systems/rest/v1/automation" as Web request URL.
    2. Select POST as HTTP method.
    3. Select Custom data as Web request body.
    4. Copy this request body template to Custom data: 
      client: {{rule.name}}
export:
  view: PDF
  viewContext: SINGLE_ISSUE_VIEW
  jql: key = {{issue.key}}  # set your JQL query
  columnConfiguration: USER_DEFAULT
actions:
  - name: Send PDF as email attachment
    type: SEND
    to: [ alice@acme.com, bob@acme.com, cecil@acme.com ]  # set your recipients
    cc: [ david@acme.com ]  # set or remove this line
    bcc: [ emily@acme.com ]  # set or remove this line
    subject: Project FOO stand-up report on {{now.jiraDate}}  # set your email subject
    body: Find the <b>PDF file</b> attached to this email.<br>  # set your email body
          Happy reading!
  - name: Call back to Jira Cloud Automation
    type: CALL
    url: https://automation.atlassian.com/pro/hooks/123450abcde  # set your callback rule's URL
    5. Set the actual values for the fields marked with # set ...:
      1. For the fields in the export: section:
        1. Open a new browser tab and generate the YAML fragment.
        2. Overwrite the whole export: section with the generated one.
      2. For the fields in the actions: section:
        1. At the SEND action, set the recipients, email subject and body (help).
        2. At the CALL action, set the callback rule's URL (help).
    6. Make sure that the indentation still looks like above after your changes. (Wrong indentation will break the request body!)
    7. Check the Delay execution of subsequent rule actions... option. (Needed for the next action to be able to write the ID received in the response to the log.)
    8. Add the required request headers to Headers.
  7. Click Next → THEN: Add an action.
  8. Select the Log action (not Log work!) and copy this to Log message: 
    PDF automation started. (ID: {{webResponse.body.messageId}})
  9. Click Turn on rule at the top.
  10. Enter "Send PDF on issue event" to Rule name. (You can use any name as long as it is intuitive.)
  11. Click Turn on rule again → Return to rules.
  12. You're done!

How to know which Jira site and which automation rule sent an email?

If you use multiple Jira sites, or you have multiple automation rules to send emails, or you received an unexpected email, it can be useful to identify the sender. To help with this, each email sent by the app contains the following custom email header fields.

Header field name Value (example) Description
X-Midori-Base-Url https://mysite.atlassian.net The base URL of the Jira Cloud site on which the automation rule which sent this email was executed.
X-Midori-Client Every morning, email the task list The name of the automation rule which sent this email. (It is essentially the value of the client field from the automation request body.)

Questions?

Ask us any time.