GitScrum / Docs

Sprint Criado

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

Disparado quando um novo sprint é criado no projeto.

  • Evento: sprints.store
  • Categoria: Sprints
  • Gatilhos: Criar um sprint via painel de sprints

Payload

O payload contém o recurso completo do sprint 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
  }
}

Referência de Campos

CampoTipoDescrição
idintegerID do sprint
codestringCódigo do sprint (ex: S-15)
slugstringIdentificador amigável para URL
titlestringNome do sprint
colorstringCódigo de cor hexadecimal
timeboxobjectContém objetos de data start e finish
durationintegerDuração do sprint em dias
date_startstringData de início (YYYY-MM-DD)
date_finishstringData de término (YYYY-MM-DD)
descriptionstring ou nullDescrição do sprint (HTML)
closeonfinishbooleanSe as tarefas fecham automaticamente quando o sprint termina
companyobjectslug e name do workspace
projectobjectslug e name do projeto
statsobjectContagens: storypoints, workedhours, totaltasks, opentasks, closed_tasks, percentage, comments
statusobjectStatus com slug, title, color, description
userobjectCriador
usersarrayMembros atribuídos às tarefas do sprint
closed_atobject ou nullTimestamp de encerramento
created_atobjectTimestamp de criação

Notas

  • timebox.start e timebox.finish usam o formato completo DateResource com dateforhumans, iso8601 e timestamp.
  • status.slug é um de: open, closed, archived.
  • duration é calculado a partir das datas de início/término.

Relacionado