Start tasks from Backlog
Connect your Backlog space once, and your team starts Jaah tasks from Backlog issues: assign an issue to
Jaah, mention Jaah in a comment, or add the jaah category. Jaah posts the task's link, its questions, its
pull request and its outcome on the issue, and closes the issue when the task is done.
Who can do this: Owners and Admins of your organization. In Backlog you need a space administrator to add a user.
Before you start
-
In Backlog, add a member named Jaah to your space. This is the user people assign issues to and mention, and every comment Jaah posts is signed by it. Backlog invites members by email: an address such as
you+jaah@example.comreaches your own mailbox, so you can finish creating the user. -
Add the Jaah user to each Backlog project whose issues should start tasks. Make it a project administrator: Backlog lets only project administrators add webhooks, and Jaah adds its own.
-
In each of those projects, add a category named
jaahunder Project settings > Categories, if you want to start tasks with a category. -
Sign in to Backlog as the Jaah user and create an API key under Personal settings › API. In Jaah, open Directory, then Secrets, select Add secret and choose Backlog. Enter your space's address and the key, or sign in to Backlog as the Jaah user instead. See Backlog.
Use the Jaah user's key, not your own. Jaah acts as whoever owns the key: with your own key, assigning an issue to the Jaah user and mentioning it start nothing, and your own comments are skipped as Jaah's. Only the category still works.
Connect the space
- Open Settings › Integrations › Issue trackers and select Add tracker.
- Choose Backlog as the Tracker. The page lists the steps from Before you start beside the fields. Pick the Jaah user's secret as the Secret, or choose Add new… to make it here. Site fills from it.
- Select Next.
There is no URL or secret to copy: Jaah adds a webhook named Jaah to every project the Jaah user belongs to. The connection's automation appears under Automations. It files a coder task, Full Auto, in the mapped project.
If Next says Backlog refused the secret, the key was deleted or belongs to another space.
Map projects
The setup goes on in steps:
- On Projects, pick the Backlog project, then the Jaah project its tasks go to; Add another row for each project. Select Next.
- On Labels & people, change Start label if your category is not
jaah. - Under Done state, type the Backlog status a done task moves the issue to. Empty means Done, or Closed in a project that has no Done status.
- Select Finish.
Later changes go on the connection's Mapping tab, behind Save.
Project editors can link Backlog projects from their project instead: see Link a project to an issue tracker.
Added the Jaah user to another Backlog project later? Map it on Mapping and select Save: saving adds the webhook to the new project.
Let your team start tasks
Backlog does not prove that a member's email address is theirs, so Jaah does not match Backlog users to your organization's members by email. To let your Backlog members start tasks, open People and turn on Non-members can start tasks. Anyone who can edit an issue in a mapped project can then start a task.
Start a task
In an issue of a mapped project, do one of these:
- Set Assignee to Jaah.
- Mention Jaah in a comment, such as
@jaah please fix the copy. The comment becomes the task's instruction. - Add the
jaahcategory.
Within about 30 seconds Jaah comments with the task's link. Doing it again while the task runs starts no second task.
To stop the task, change the assignee away from Jaah or remove the category.
If the connection signs in with your own Backlog account, assigning an issue to yourself starts nothing: add the category instead.
Answer Jaah
When the task asks a question, Jaah posts it on the issue. Reply with a comment: the reply answers the question, or reaches the task as a comment when no question is open. See Link a project to an issue tracker for everything Jaah posts back.
Delete the tracker
On the connection's page, or on its row in Issue trackers, select ⋯ > Delete. Jaah removes its webhooks from your Backlog projects. Tasks it already started stay.
If nothing happens
- No "started" comment. Open the connection's Events tab (see Check what a tracker did with an issue). No event means Backlog sent none: check that the project has the Jaah webhook under Project settings > Integrations > Webhooks, and that the project is mapped. Filtered with "is not a member of this organization" means Non-members can start tasks is off.
- The category starts tasks, but assigning and mentioning do not. The tracker's secret holds your own Backlog key, not the Jaah user's. Create a secret with the Jaah user's key, delete the tracker and add it again with that secret: a tracker's secret cannot be changed on its page.
- The issue does not close. The project has no status named as the Done state. Type one it has.