GitScrum / Docs

Sprint Atualizado

Referência de payload do webhook para o evento sprints.update, disparado quando um sprint é atualizado.

Disparado quando um sprint é atualizado.

  • Evento: sprints.update
  • Categoria: Sprints
  • Gatilhos: Editar título, datas, descrição, cor, status ou configurações do sprint

Payload

O payload contém o recurso completo do sprint, idêntico em estrutura a 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
  }
}

Referência de Campos

Consulte a referência completa de campos em Sprint Criado. A estrutura do payload é idêntica — todos os campos do SprintResource são incluídos independentemente de qual campo foi alterado.

Notas

  • O recurso completo do sprint é sempre enviado, não apenas os campos alterados.
  • stats reflete as contagens atuais no momento do evento.
  • Fechar um sprint dispara este evento com status.slug: "closed" e closed_at preenchido.

Relacionado