GitScrum / Docs

User Story Updated

Webhook payload reference for the user-stories.update event, triggered when a user story is updated.

Triggered when a user story is updated.

  • Event: user-stories.update
  • Category: User Stories
  • Triggers: Editing any field of a user story (title, description, priority, acceptance criteria, epic)

Payload

The payload contains the full user story resource, identical in structure to user-stories.store:

{
  "id": 10,
  "code": "US-10",
  "slug": "user-login-flow",
  "title": "As a user, I want to log in with OAuth",
  "votes": 3,
  "additional_information": "<p>Support Google, GitHub, and Microsoft OAuth providers.</p>",
  "additional_information_mention": null,
  "acceptance_criteria": "<p>Given a valid OAuth token, the user is authenticated within 2 seconds.</p>",
  "acceptance_criteria_mention": null,
  "priority": {
    "id": 1,
    "title": "Critical",
    "color": "#DC2626",
    "total": 2
  },
  "epic": {
    "uuid": "epic-uuid-123",
    "title": "Authentication Module",
    "color": "#8B5CF6",
    "stats": {
      "user_stories": 8
    },
    "user": { ... },
    "created_at": {
      "date_for_humans": "2 weeks ago",
      "iso8601": "2026-01-23T10:00:00+00:00",
      "timestamp": 1737622800
    }
  },
  "company": {
    "slug": "acme-corp",
    "name": "Acme Corp"
  },
  "project": {
    "slug": "web-platform",
    "name": "Web Platform"
  },
  "stats": {
    "story_points": 13,
    "worked_hours": 8,
    "total_tasks": 5,
    "closed_tasks": 2,
    "percentage": 40,
    "comments": 7
  },
  "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": { ... }
  },
  "users": [],
  "created_at": {
    "date_for_humans": "1 hour ago",
    "iso8601": "2026-02-06T13:00:00+00:00",
    "timestamp": 1738846800
  }
}

Field Reference

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

Notes

  • The full user story resource is always sent, not just the changed fields.
  • The stats object reflects current counts at the time of the event.
  • priority and epic may be null if not assigned.

Related