Sprint Created

Webhook payload reference for the sprints.store event, triggered when a sprint is created.

Triggered when a new sprint is created in the project.

Event: sprints.store
Category: Sprints
Triggers: Creating a sprint via the sprints panel

Payload

The payload contains the full sprint resource via SprintResource:

{
  "id": 15,
  "code": "S-15",
  "slug": "sprint-q1-week-3",
  "title": "Q1 Week 3",
  "color": "#3B82F6",
  "timebox": {
    "start": {
      "date_for_humans": "Feb 10, 2026",
      "iso8601": "2026-02-10T00:00:00+00:00",
      "timestamp": 1739145600
    },
    "finish": {
      "date_for_humans": "Feb 24, 2026",
      "iso8601": "2026-02-24T00:00:00+00:00",
      "timestamp": 1740355200
    }
  },
  "duration": 14,
  "date_start": "2026-02-10",
  "date_finish": "2026-02-24",
  "description": "<p>Focus on authentication and payment integration.</p>",
  "close_on_finish": false,
  "company": {
    "slug": "acme-corp",
    "name": "Acme Corp"
  },
  "project": {
    "slug": "web-platform",
    "name": "Web Platform"
  },
  "stats": {
    "story_points": 0,
    "worked_hours": 0,
    "total_tasks": 0,
    "open_tasks": 0,
    "closed_tasks": 0,
    "percentage": 0,
    "comments": 0
  },
  "status": {
    "slug": "open",
    "title": "Open",
    "color": "#3B82F6",
    "description": null
  },
  "user": {
    "id": 1,
    "uuid": "user-uuid-123",
    "name": "Jane Smith",
    "username": "janesmith",
    "avatar": "https://avatar.url/jane.jpg",
    "headline": "Lead Developer",
    "location": "Porto, Portugal",
    "timezone_name": "Europe/Lisbon",
    "language": "en",
    "created_at": {
      "date_for_humans": "1 year ago",
      "iso8601": "2025-01-15T10:00:00+00:00",
      "timestamp": 1736935200
    }
  },
  "users": [],
  "closed_at": null,
  "created_at": {
    "date_for_humans": "Just now",
    "iso8601": "2026-02-06T14:30:00+00:00",
    "timestamp": 1738852200
  }
}

Field Reference

Field	Type	Description
`id`	integer	Sprint ID
`code`	string	Sprint code (e.g., `S-15`)
`slug`	string	URL-friendly identifier
`title`	string	Sprint name
`color`	string	Hex color code
`timebox`	object	Contains `start` and `finish` date objects
`duration`	integer	Sprint length in days
`date_start`	string	Start date (`YYYY-MM-DD`)
`date_finish`	string	End date (`YYYY-MM-DD`)
`description`	string or null	Sprint description (HTML)
`closeonfinish`	boolean	Whether tasks auto-close when sprint ends
`company`	object	Workspace `slug` and `name`
`project`	object	Project `slug` and `name`
`stats`	object	Counts: `storypoints`, `worked``hours`, `totaltasks`, `open``tasks`, `closed_tasks`, `percentage`, `comments`
`status`	object	Status with `slug`, `title`, `color`, `description`
`user`	object	Creator
`users`	array	Members assigned to sprint tasks
`closed_at`	object or null	Closure timestamp
`created_at`	object	Creation timestamp

Notes

timebox.start and timebox.finish use the full DateResource format with dateforhumans, iso8601, and timestamp.
status.slug is one of: open, closed, archived.
duration is computed from start/finish dates.

Sprint Updated — sprints.update
Sprint Deleted — sprints.destroy

Sprint Created

Payload

Field Reference

Notes

Related