Skip to content
Yamuno
Browse

Jira Automation

The Automation tab with the web request URL and token

Any Automation rule can change a checklist through the app's web request URL.

Setting it up

  1. In Jira settings → Apps → Simple Checklist → Automation, copy the Web request URL and the token.
  2. In your rule, add a Send web request action:
    • Web request URL: the URL you copied
    • HTTP method: POST
    • Web request body: Custom data
    • Headers: Content-Type: application/json and X-Checklist-Token: <your token>
  3. Put one of the request bodies below in Custom data.

Request bodies

Add an item (requirement is optional):

{ "issueKey": "{{issue.key}}", "action": "addItem", "text": "Notify customer", "requirement": "required" }

Add several items:

{ "issueKey": "{{issue.key}}", "action": "addItems", "items": [{ "text": "Rollback plan" }, { "text": "Status page updated" }] }

Apply a template, by name or id:

{ "issueKey": "{{issue.key}}", "action": "applyTemplate", "template": "Definition of Done" }

Complete an item by its text (not case-sensitive), or everything:

{ "issueKey": "{{issue.key}}", "action": "completeItem", "text": "Code reviewed" }
{ "issueKey": "{{issue.key}}", "action": "completeAll" }

Changes made this way appear in the checklist's activity as Automation.

Keeping the token safe

Anyone with the URL and token can change checklists, so treat the token like a password. Generate new token replaces it straight away; update your rules afterwards.

Stuck on something this page does not cover? Ask the developers.