Create Sprint
jira.create_sprint
ActionBusiness appsconnection required
Calls the Jira Cloud REST API with the connection's email and API token.
Create a sprint on a Jira Software scrum board.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Username & password
- Providers
- Jira
- Secret shape
- {"email", "api_token"}
- Config it needs
- domain
- Resolved by
- config.connection_id, else node.connection_id
Configuration
5 fields, 2 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
name The sprint's name, e.g. 'Sprint 24'. | string | Yes | — | — | — |
board_id Numeric id of the scrum board the sprint belongs to. | string | Yes | — | — | 10021 |
start_date When the sprint starts, ISO-8601, e.g. 2026-09-14T09:00:00.000+00:00. | string | No | — | iso8601 format | — |
end_date When the sprint ends, ISO-8601. Must be after start_date. | string | No | — | iso8601 format | — |
goal The sprint goal. | string | No | — | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"board_id": "10021"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
id The new sprint's id. | number | — |
name The sprint's name. | string | — |
state A new sprint is always created in the 'future' state. | string | — |
startDate When the sprint starts, ISO-8601. | string | — |
endDate When the sprint ends, ISO-8601. | string | — |
goal The sprint goal, when one was set. | string | — |
originBoardId The board the sprint was created on. | number | — |
{
"endDate": "",
"goal": "",
"id": 0,
"name": "",
"originBoardId": 0,
"startDate": "",
"state": ""
}Notes
- Boards, sprints and the backlog are Jira Software's API (/rest/agile/1.0), not the platform API — they exist only on a site with Jira Software, and only company-managed and team-managed software projects have boards.
- A sprint is created in the 'future' state; starting it is a separate edit.
See Create Sprint run in a workflow.
In a technical demo we add the Jira connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.