Connect an API Tester project to a board
Send a project's bugs and stories to a board, and create a bug or story from a request or run.
In short
A board can be connected to an API Tester project, so the project's bugs and stories land on the board. From a request or run you then create a bug or story card with the evidence attached. The other module stays the source of truth.
Before you start
- Who: connecting needs "Create and manage boards" on the board plus access to the API Tester project. Creating a bug or story from a request needs "Change cards".
- Plan: Boards and API Tester must both be on your plan. A board the platform makes for a project tracker is never refused for the plan's board limit.
- First: have the board and the project in the same workspace.
Steps
- Open the board and choose Board settings › "Connections", then press "Set up" on "Other products".
- Under the module's heading, search for the record and choose "Connect".
- In API Tester, open the project's Project connections screen.
- Open the "Connect a board" tab and choose "Connect" beside a board you can manage.
- In API Tester, on a request, choose "Create a board card or attach this request to an existing one". On a run, the same action reads "Create a board card or attach this exact run to an existing one".
- Pick a connected board and a card type, give it a title and a priority, and a severity for a bug.
Result: the card is created in the board's first column with the request or run attached as evidence.
Good to know
- Nothing connects automatically, and opening a project never creates a board. You need the manage permission on the board and access to the record.
- "Connected boards" lists every board that receives the project's work. One board can track several projects and one project can feed several boards. Disconnecting leaves existing cards where they are.
- A SQL Tester project, Cache Tester connection, UI Tester site, Planner cycle or Notes notebook connects as a shortcut you open from the board and never creates or moves cards.
- A Jobs & hiring role opens its own board. See /help/jobs/hiring-board.
- Up to ten records per action. A bug made from a run takes the run's HTTP status code. A story starts with empty acceptance criteria.
- If the project is disconnected later, or you lose access, the evidence shows as unavailable instead of leaking details.
- The board never shows more about a record than you may see in its own module.
- What happens next: cards appear in the board's first column with the evidence attached. Disconnecting leaves existing cards where they are.
If something goes wrong
- "The API Tester project must be connected to this board before creating linked work."
- "That record is unavailable or you do not have access to it."
- "This card already belongs to another API Tester project."
- "This board uses the legacy project tracker. Bind the project to a standalone board instead."
Related
- /help/boards/bug-triage
- /help/boards/links-and-checks
- /help/api-testing/workspace-projects-folders