GitScrum / Docs

Sprint Updated

Webhook payload reference for the sprints.update event, triggered when a sprint is updated.

Triggered when a sprint is updated.

  • Event: sprints.update
  • Category: Sprints
  • Triggers: Editing sprint title, dates, description, color, status, or settings

Payload

The payload contains the full sprint resource, identical in structure to sprints.store:

{
  "id": 15,
  "code": "S-15",
  "slug": "sprint-q1-week-3",
  "title": "Q1 Week 3 — Extended",
  "color": "#10B981",
  "timebox": {
    "start": {
      "date_for_humans": "Feb 10, 2026",
      "iso8601": "2026-02-10T00:00:00+00:00",
      "timestamp": 1739145600
    },
    "finish": {
      "date_for_humans": "Feb 28, 2026",
      "iso8601": "2026-02-28T00:00:00+00:00",
      "timestamp": 1740700800
    }
  },
  "duration": 18,
  "date_start": "2026-02-10",
  "date_finish": "2026-02-28",
  "description": "<p>Extended by 4 days to accommodate payment module.</p>",
  "close_on_finish": true,
  "company": {
    "slug": "acme-corp",
    "name": "Acme Corp"
  },
  "project": {
    "slug": "web-platform",
    "name": "Web Platform"
  },
  "stats": {
    "story_points": 34,
    "worked_hours": 28,
    "total_tasks": 12,
    "open_tasks": 5,
    "closed_tasks": 7,
    "percentage": 58,
    "comments": 23
  },
  "status": {
    "slug": "open",
    "title": "Open",
    "color": "#3B82F6",
    "description": null
  },
  "user": { ... },
  "users": [],
  "closed_at": null,
  "created_at": {
    "date_for_humans": "3 days ago",
    "iso8601": "2026-02-03T14:30:00+00:00",
    "timestamp": 1738593000
  }
}

Field Reference

See the full field reference in Sprint Created. The payload structure is identical — all fields from the SprintResource are included regardless of which field changed.

Notes

  • The full sprint resource is always sent, not just the changed fields.
  • stats reflects current counts at the time of the event.
  • Closing a sprint triggers this event with status.slug: "closed" and closed_at populated.

Related