GitScrum / Docs

User Story Created

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

Triggered when a new user story is created in the project.

  • Event: user-stories.store
  • Category: User Stories
  • Triggers: Creating a user story via the user stories panel

Payload

The payload contains the full user story resource via UserStoryResource:

{
  "id": 10,
  "code": "US-10",
  "slug": "user-login-flow",
  "title": "As a user, I want to log in with OAuth",
  "votes": 0,
  "additional_information": "<p>Support Google and GitHub OAuth providers.</p>",
  "additional_information_mention": null,
  "acceptance_criteria": "<p>Given a valid OAuth token, the user is authenticated.</p>",
  "acceptance_criteria_mention": null,
  "priority": {
    "id": 2,
    "title": "High",
    "color": "#EF4444",
    "total": 5
  },
  "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": 5,
    "worked_hours": 0,
    "total_tasks": 3,
    "closed_tasks": 0,
    "percentage": 0,
    "comments": 0
  },
  "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": [],
  "created_at": {
    "date_for_humans": "Just now",
    "iso8601": "2026-02-06T14:30:00+00:00",
    "timestamp": 1738852200
  }
}

Field Reference

FieldTypeDescription
idintegerUser story ID
codestringUser story code (e.g., US-10)
slugstringURL-friendly identifier
titlestringUser story title
votesintegerVote count
additional_informationstring or nullExtra details (HTML)
acceptance_criteriastring or nullAcceptance criteria (HTML)
priorityobject or nullPriority with id, title, color, total
epicobject or nullEpic with uuid, title, color, stats, user, created_at
companyobjectWorkspace slug and name
projectobjectProject slug and name
statsobjectCounts: storypoints, workedhours, totaltasks, closedtasks, percentage, comments
userobjectCreator
usersarrayUsers from assigned tasks
created_atobjectCreation timestamp